diff --git a/CHANGELOG b/CHANGELOG index fd0a0e23129..f50f0e65d07 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,14 @@ +v1.5.0 + Version 1.5.0 + + Release to support oauth2client >= 2.0.0. + + - Fix file stream recognition in Python 3 (#141) + - Fix non-resumable binary uploads in Python 3 (#147) + - Default to 'octet-stream' if mimetype detection fails (#157) + - Handle SSL errors with retries (#160) + - Fix incompatibility with oauth2client v2.0.0 (#182) + v1.4.2 Version 1.4.2 diff --git a/describe.py b/describe.py index 5dcac904c61..c5b15a7452f 100755 --- a/describe.py +++ b/describe.py @@ -33,6 +33,7 @@ from googleapiclient.discovery import DISCOVERY_URI from googleapiclient.discovery import build from googleapiclient.discovery import build_from_document +from googleapiclient.discovery import UnknownApiNameOrVersion import httplib2 import uritemplate @@ -339,7 +340,12 @@ def document_api(name, version): name: string, Name of the API. version: string, Version of the API. """ - service = build(name, version) + try: + service = build(name, version) + except UnknownApiNameOrVersion as e: + print 'Warning: {} {} found but could not be built.'.format(name, version) + return + response, content = http.request( uritemplate.expand( FLAGS.discovery_uri_template, { diff --git a/docs/dyn/adexchangebuyer_v1_4.budget.html b/docs/dyn/adexchangebuyer_v1_4.budget.html index 3e190a851d5..fbaad50e4f7 100644 --- a/docs/dyn/adexchangebuyer_v1_4.budget.html +++ b/docs/dyn/adexchangebuyer_v1_4.budget.html @@ -97,7 +97,7 @@

Method Details

{ # The configuration data for Ad Exchange RTB - Budget API. "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget". - "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests. + "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here. "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. "id": "A String", # The unique id that describes this item. @@ -117,7 +117,7 @@

Method Details

{ # The configuration data for Ad Exchange RTB - Budget API. "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget". - "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests. + "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here. "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. "id": "A String", # The unique id that describes this item. @@ -130,7 +130,7 @@

Method Details

{ # The configuration data for Ad Exchange RTB - Budget API. "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget". - "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests. + "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here. "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. "id": "A String", # The unique id that describes this item. @@ -150,7 +150,7 @@

Method Details

{ # The configuration data for Ad Exchange RTB - Budget API. "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget". - "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests. + "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here. "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. "id": "A String", # The unique id that describes this item. @@ -163,7 +163,7 @@

Method Details

{ # The configuration data for Ad Exchange RTB - Budget API. "kind": "adexchangebuyer#budget", # The kind of the resource, i.e. "adexchangebuyer#budget". - "budgetAmount": "A String", # The budget amount to apply for the billingId provided. This is required for update requests. + "budgetAmount": "A String", # The daily budget amount in unit amount of the account currency to apply for the billingId provided. This is required for update requests. "currencyCode": "A String", # The currency code for the buyer. This cannot be altered here. "billingId": "A String", # The billing id to determine which adgroup to provide budget information for. This is required for get and update requests. "id": "A String", # The unique id that describes this item. diff --git a/docs/dyn/adexchangebuyer_v1_4.creatives.html b/docs/dyn/adexchangebuyer_v1_4.creatives.html index 19382d906fd..133e8814ad1 100644 --- a/docs/dyn/adexchangebuyer_v1_4.creatives.html +++ b/docs/dyn/adexchangebuyer_v1_4.creatives.html @@ -74,6 +74,9 @@

Ad Exchange Buyer API . creatives

Instance Methods

+

+ addDeal(accountId, buyerCreativeId, dealId)

+

Add a deal id association for the creative.

get(accountId, buyerCreativeId)

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

@@ -86,7 +89,21 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

+ removeDeal(accountId, buyerCreativeId, dealId)

+

Remove a deal id associated with the creative.

Method Details

+
+ addDeal(accountId, buyerCreativeId, dealId) +
Add a deal id association for the creative.
+
+Args:
+  accountId: integer, The id for the account that will serve this creative. (required)
+  buyerCreativeId: string, The buyer-specific id for this creative. (required)
+  dealId: string, The id of the deal id to associate with this creative. (required)
+
+
+
get(accountId, buyerCreativeId)
Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
@@ -99,7 +116,6 @@ 

Method Details

An object of the form: { # A creative and its classification data. - "api_upload_timestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "attribute": [ # All attributes for the ads that may be shown from this snippet. 42, ], @@ -146,6 +162,7 @@

Method Details

"clickTrackingUrl": "A String", # The URL to use for click tracking. }, "version": 42, # The version for this creative. Read-only. This field should not be set in requests. + "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "vendorType": [ # All vendor types for the ads that may be shown from this snippet. 42, ], @@ -220,7 +237,6 @@

Method Details

The object takes the form of: { # A creative and its classification data. - "api_upload_timestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "attribute": [ # All attributes for the ads that may be shown from this snippet. 42, ], @@ -267,6 +283,7 @@

Method Details

"clickTrackingUrl": "A String", # The URL to use for click tracking. }, "version": 42, # The version for this creative. Read-only. This field should not be set in requests. + "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "vendorType": [ # All vendor types for the ads that may be shown from this snippet. 42, ], @@ -336,7 +353,6 @@

Method Details

An object of the form: { # A creative and its classification data. - "api_upload_timestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "attribute": [ # All attributes for the ads that may be shown from this snippet. 42, ], @@ -383,6 +399,7 @@

Method Details

"clickTrackingUrl": "A String", # The URL to use for click tracking. }, "version": 42, # The version for this creative. Read-only. This field should not be set in requests. + "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "vendorType": [ # All vendor types for the ads that may be shown from this snippet. 42, ], @@ -453,12 +470,12 @@

Method Details

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
 
 Args:
-  dealsStatusFilter: string, When specified, only creatives having the given direct deals status are returned.
+  dealsStatusFilter: string, When specified, only creatives having the given deals status are returned.
     Allowed values
-      approved - Creatives which have been approved for serving on direct deals.
-      conditionally_approved - Creatives which have been conditionally approved for serving on direct deals.
-      disapproved - Creatives which have been disapproved for serving on direct deals.
-      not_checked - Creatives whose direct deals status is not yet checked.
+      approved - Creatives which have been approved for serving on deals.
+      conditionally_approved - Creatives which have been conditionally approved for serving on deals.
+      disapproved - Creatives which have been disapproved for serving on deals.
+      not_checked - Creatives whose deals status is not yet checked.
   openAuctionStatusFilter: string, When specified, only creatives having the given open auction status are returned.
     Allowed values
       approved - Creatives which have been approved for serving on the open auction.
@@ -477,7 +494,6 @@ 

Method Details

"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this. "items": [ # A list of creatives. { # A creative and its classification data. - "api_upload_timestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "attribute": [ # All attributes for the ads that may be shown from this snippet. 42, ], @@ -524,6 +540,7 @@

Method Details

"clickTrackingUrl": "A String", # The URL to use for click tracking. }, "version": 42, # The version for this creative. Read-only. This field should not be set in requests. + "apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp). "vendorType": [ # All vendor types for the ads that may be shown from this snippet. 42, ], @@ -606,4 +623,15 @@

Method Details

+
+ removeDeal(accountId, buyerCreativeId, dealId) +
Remove a deal id associated with the creative.
+
+Args:
+  accountId: integer, The id for the account that will serve this creative. (required)
+  buyerCreativeId: string, The buyer-specific id for this creative. (required)
+  dealId: string, The id of the deal id to disassociate with this creative. (required)
+
+
+ \ No newline at end of file diff --git a/docs/dyn/adexchangebuyer_v1_4.html b/docs/dyn/adexchangebuyer_v1_4.html index 0d2274be604..8ab0fc311b7 100644 --- a/docs/dyn/adexchangebuyer_v1_4.html +++ b/docs/dyn/adexchangebuyer_v1_4.html @@ -89,21 +89,11 @@

Instance Methods

Returns the budget Resource.

-

- clientaccess() -

-

Returns the clientaccess Resource.

-

creatives()

Returns the creatives Resource.

-

- deals() -

-

Returns the deals Resource.

-

marketplacedeals()

@@ -115,39 +105,24 @@

Instance Methods

Returns the marketplacenotes Resource.

- marketplaceoffers() -

-

Returns the marketplaceoffers Resource.

- -

- marketplaceorders() -

-

Returns the marketplaceorders Resource.

- -

- negotiationrounds() -

-

Returns the negotiationrounds Resource.

- -

- negotiations() + performanceReport()

-

Returns the negotiations Resource.

+

Returns the performanceReport Resource.

- offers() + pretargetingConfig()

-

Returns the offers Resource.

+

Returns the pretargetingConfig Resource.

- performanceReport() + products()

-

Returns the performanceReport Resource.

+

Returns the products Resource.

- pretargetingConfig() + proposals()

-

Returns the pretargetingConfig Resource.

+

Returns the proposals Resource.

new_batch_http_request()

diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html index f2b025e4597..dcb1eb5f4d0 100644 --- a/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html +++ b/docs/dyn/adexchangebuyer_v1_4.marketplacedeals.html @@ -75,31 +75,31 @@

Ad Exchange Buyer API . marketplacedeals

Instance Methods

- delete(orderId, body)

-

Delete the specified deals from the order

+ delete(proposalId, body)

+

Delete the specified deals from the proposal

- insert(orderId, body)

-

Add new deals for the specified order

+ insert(proposalId, body)

+

Add new deals for the specified proposal

- list(orderId)

-

List all the deals for a given order

+ list(proposalId)

+

List all the deals for a given proposal

- update(orderId, body)

-

Replaces all the deals in the order with the passed in deals

+ update(proposalId, body)

+

Replaces all the deals in the proposal with the passed in deals

Method Details

- delete(orderId, body) -
Delete the specified deals from the order
+    delete(proposalId, body)
+  
Delete the specified deals from the proposal
 
 Args:
-  orderId: string, The orderId to delete deals from. (required)
+  proposalId: string, The proposalId to delete deals from. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "orderRevisionNumber": "A String", # The last known order revision number.
+    "proposalRevisionNumber": "A String", # The last known proposal revision number.
     "updateAction": "A String",
-    "dealIds": [ # List of deals to delete for a given order
+    "dealIds": [ # List of deals to delete for a given proposal
       "A String",
     ],
   }
@@ -109,8 +109,8 @@ 

Method Details

An object of the form: { - "deals": [ # List of deals deleted (in the same order as passed in the request) - { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving. + "deals": [ # List of deals deleted (in the same proposal as passed in the request) + { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. "frequencyCaps": [ { @@ -119,55 +119,11 @@

Method Details

"maxImpressions": 42, }, ], + "creativeBlockingLevel": "A String", "deliveryRateType": "A String", }, - "orderId": "A String", "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". - "terms": { # The negotiable terms of the deal. (updatable) - "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. - "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. - "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer. - }, - "description": "A String", # Description for the proposed terms of the deal. - "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. - "reservePricePerBuyers": [ # Reserve price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - "privateAuctionId": "A String", # Id of the corresponding private auction. - }, - "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. - "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - }, - }, + "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly) "name": "A String", # The name of the deal. (updatable) "buyerPrivateData": { # Buyer private data (hidden from seller). "referenceId": "A String", @@ -200,7 +156,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -231,7 +187,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -242,7 +198,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -251,87 +207,99 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) - "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) - "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) - "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) - "inventoryDescription": "A String", # Description for the deal terms. (updatable) - }, - ], - "orderRevisionNumber": "A String", # The updated revision number for the order. - }
-
- -
- insert(orderId, body) -
Add new deals for the specified order
-
-Args:
-  orderId: string, OrderId for which deals need to be added. (required)
-  body: object, The request body. (required)
-    The object takes the form of:
-
-{
-    "deals": [ # The list of deals to add
-      { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
-        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
-          "frequencyCaps": [
-            {
-              "numTimeUnits": 42,
-              "timeUnitType": "A String",
-              "maxImpressions": 42,
-            },
-          ],
-          "deliveryRateType": "A String",
-        },
-        "orderId": "A String",
-        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
         "terms": { # The negotiable terms of the deal. (updatable)
-          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
-            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+          "brandingType": "A String", # Visibilty of the URL in bid requests.
+          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+            "pricingType": "A String", # The pricing type for the deal/product.
+            "currencyCode": "A String", # The currency code for the price.
+            "amountMicros": 3.14, # The price value in micros.
+          },
+          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
             "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
           },
-          "description": "A String", # Description for the proposed terms of the deal.
-          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
-            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+            "fixedPrices": [ # Fixed price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "privateAuctionId": "A String", # Id of the corresponding private auction.
+            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
           },
-          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
-            "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
+            "privateAuctionId": "A String", # Id of the corresponding private auction.
           },
+          "description": "A String", # Description for the proposed terms of the deal.
+        },
+        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+      },
+    ],
+    "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
+  }
+
+ +
+ insert(proposalId, body) +
Add new deals for the specified proposal
+
+Args:
+  proposalId: string, proposalId for which deals need to be added. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "deals": [ # The list of deals to add
+      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+          "frequencyCaps": [
+            {
+              "numTimeUnits": 42,
+              "timeUnitType": "A String",
+              "maxImpressions": 42,
+            },
+          ],
+          "creativeBlockingLevel": "A String",
+          "deliveryRateType": "A String",
         },
+        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
         "name": "A String", # The name of the deal. (updatable)
         "buyerPrivateData": { # Buyer private data (hidden from seller).
           "referenceId": "A String",
@@ -364,7 +332,7 @@ 

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -395,7 +363,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -406,7 +374,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -415,82 +383,94 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) - "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) - "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) - "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) - "inventoryDescription": "A String", # Description for the deal terms. (updatable) - }, - ], - "orderRevisionNumber": "A String", # The last known order revision number. - "updateAction": "A String", # Indicates an optional action to take on the order - } - - -Returns: - An object of the form: - - { - "deals": [ # List of deals added (in the same order as passed in the request) - { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving. - "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. - "frequencyCaps": [ - { - "numTimeUnits": 42, - "timeUnitType": "A String", - "maxImpressions": 42, - }, - ], - "deliveryRateType": "A String", - }, - "orderId": "A String", - "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". "terms": { # The negotiable terms of the deal. (updatable) - "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. - "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. + "brandingType": "A String", # Visibilty of the URL in bid requests. + "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller. + "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). "accountId": "A String", # Adx account id of the buyer. }, "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. + "amountMicros": 3.14, # The price value in micros. }, }, ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer. }, - "description": "A String", # Description for the proposed terms of the deal. - "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. - "reservePricePerBuyers": [ # Reserve price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. + "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. + "fixedPrices": [ # Fixed price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). "accountId": "A String", # Adx account id of the buyer. }, "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. + "amountMicros": 3.14, # The price value in micros. }, }, ], - "privateAuctionId": "A String", # Id of the corresponding private auction. + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. }, - "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. - "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. + "reservePricePerBuyers": [ # Reserve price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). "accountId": "A String", # Adx account id of the buyer. }, "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. + "amountMicros": 3.14, # The price value in micros. }, }, ], + "privateAuctionId": "A String", # Id of the corresponding private auction. }, + "description": "A String", # Description for the proposed terms of the deal. + }, + "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) + "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) + "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) + "inventoryDescription": "A String", # Description for the deal terms. (updatable) + "productId": "A String", # The product-id from which this deal was created. (readonly, except on create) + }, + ], + "proposalRevisionNumber": "A String", # The last known proposal revision number. + "updateAction": "A String", # Indicates an optional action to take on the proposal + } + + +Returns: + An object of the form: + + { + "deals": [ # List of deals added (in the same proposal as passed in the request) + { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. + "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. + "frequencyCaps": [ + { + "numTimeUnits": 42, + "timeUnitType": "A String", + "maxImpressions": 42, + }, + ], + "creativeBlockingLevel": "A String", + "deliveryRateType": "A String", }, + "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". + "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly) "name": "A String", # The name of the deal. (updatable) "buyerPrivateData": { # Buyer private data (hidden from seller). "referenceId": "A String", @@ -523,7 +503,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -554,7 +534,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -565,7 +545,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -574,88 +554,100 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) - "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) - "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) - "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) - "inventoryDescription": "A String", # Description for the deal terms. (updatable) - }, - ], - "orderRevisionNumber": "A String", # The updated revision number for the order. - }
-
- -
- list(orderId) -
List all the deals for a given order
-
-Args:
-  orderId: string, The orderId to get deals for. (required)
-
-Returns:
-  An object of the form:
-
-    {
-    "deals": [ # List of deals for the order
-      { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
-        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
-          "frequencyCaps": [
-            {
-              "numTimeUnits": 42,
-              "timeUnitType": "A String",
-              "maxImpressions": 42,
-            },
-          ],
-          "deliveryRateType": "A String",
-        },
-        "orderId": "A String",
-        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
         "terms": { # The negotiable terms of the deal. (updatable)
-          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
-            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+          "brandingType": "A String", # Visibilty of the URL in bid requests.
+          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+            "pricingType": "A String", # The pricing type for the deal/product.
+            "currencyCode": "A String", # The currency code for the price.
+            "amountMicros": 3.14, # The price value in micros.
+          },
+          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
             "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
           },
-          "description": "A String", # Description for the proposed terms of the deal.
-          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
-            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+            "fixedPrices": [ # Fixed price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "privateAuctionId": "A String", # Id of the corresponding private auction.
+            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
           },
-          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
-            "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
+            "privateAuctionId": "A String", # Id of the corresponding private auction.
           },
+          "description": "A String", # Description for the proposed terms of the deal.
+        },
+        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+      },
+    ],
+    "proposalRevisionNumber": "A String", # The updated revision number for the proposal.
+  }
+
+ +
+ list(proposalId) +
List all the deals for a given proposal
+
+Args:
+  proposalId: string, The proposalId to get deals for. (required)
+
+Returns:
+  An object of the form:
+
+    {
+    "deals": [ # List of deals for the proposal
+      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+          "frequencyCaps": [
+            {
+              "numTimeUnits": 42,
+              "timeUnitType": "A String",
+              "maxImpressions": 42,
+            },
+          ],
+          "creativeBlockingLevel": "A String",
+          "deliveryRateType": "A String",
         },
+        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
         "name": "A String", # The name of the deal. (updatable)
         "buyerPrivateData": { # Buyer private data (hidden from seller).
           "referenceId": "A String",
@@ -688,7 +680,7 @@ 

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -719,7 +711,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -730,7 +722,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -739,86 +731,98 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) - "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) - "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) - "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) - "inventoryDescription": "A String", # Description for the deal terms. (updatable) - }, - ], - }
-
- -
- update(orderId, body) -
Replaces all the deals in the order with the passed in deals
-
-Args:
-  orderId: string, The orderId to edit deals on. (required)
-  body: object, The request body. (required)
-    The object takes the form of:
-
-{
-    "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to order If a deal in this list does not exist in the order, the service will create a new deal and add it to the order. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the order If a deal in this list already exist in the order, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the order (just need the id) If a existing deal in the order is not present in this list, the service will delete that deal from the order. Validation will follow DeleteOrderDealsRequest.
-      { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
-        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
-          "frequencyCaps": [
-            {
-              "numTimeUnits": 42,
-              "timeUnitType": "A String",
-              "maxImpressions": 42,
-            },
-          ],
-          "deliveryRateType": "A String",
-        },
-        "orderId": "A String",
-        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
         "terms": { # The negotiable terms of the deal. (updatable)
-          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
-            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+          "brandingType": "A String", # Visibilty of the URL in bid requests.
+          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+            "pricingType": "A String", # The pricing type for the deal/product.
+            "currencyCode": "A String", # The currency code for the price.
+            "amountMicros": 3.14, # The price value in micros.
+          },
+          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
             "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer.
           },
-          "description": "A String", # Description for the proposed terms of the deal.
-          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
-            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+            "fixedPrices": [ # Fixed price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
-            "privateAuctionId": "A String", # Id of the corresponding private auction.
+            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
           },
-          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
-            "fixedPrices": [ # Fixed price for the specified buyer.
-              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
                 "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
                   "accountId": "A String", # Adx account id of the buyer.
                 },
                 "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
                   "currencyCode": "A String", # The currency code for the price.
-                  "amountMicros": 3.14, # The CPM value in micros.
+                  "amountMicros": 3.14, # The price value in micros.
                 },
               },
             ],
+            "privateAuctionId": "A String", # Id of the corresponding private auction.
           },
+          "description": "A String", # Description for the proposed terms of the deal.
         },
+        "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly)
+        "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly)
+        "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)
+        "inventoryDescription": "A String", # Description for the deal terms. (updatable)
+        "productId": "A String", # The product-id from which this deal was created. (readonly, except on create)
+      },
+    ],
+  }
+
+ +
+ update(proposalId, body) +
Replaces all the deals in the proposal with the passed in deals
+
+Args:
+  proposalId: string, The proposalId to edit deals on. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "deals": [ # List of deals to edit. Service may perform 3 different operations based on comparison of deals in this list vs deals already persisted in database: 1. Add new deal to proposal If a deal in this list does not exist in the proposal, the service will create a new deal and add it to the proposal. Validation will follow AddOrderDealsRequest. 2. Update existing deal in the proposal If a deal in this list already exist in the proposal, the service will update that existing deal to this new deal in the request. Validation will follow UpdateOrderDealsRequest. 3. Delete deals from the proposal (just need the id) If a existing deal in the proposal is not present in this list, the service will delete that deal from the proposal. Validation will follow DeleteOrderDealsRequest.
+      { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
+        "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension.
+          "frequencyCaps": [
+            {
+              "numTimeUnits": 42,
+              "timeUnitType": "A String",
+              "maxImpressions": 42,
+            },
+          ],
+          "creativeBlockingLevel": "A String",
+          "deliveryRateType": "A String",
+        },
+        "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal".
+        "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly)
         "name": "A String", # The name of the deal. (updatable)
         "buyerPrivateData": { # Buyer private data (hidden from seller).
           "referenceId": "A String",
@@ -851,7 +855,7 @@ 

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -882,7 +886,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -893,7 +897,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -902,33 +906,84 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) + "terms": { # The negotiable terms of the deal. (updatable) + "brandingType": "A String", # Visibilty of the URL in bid requests. + "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller. + "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. + "fixedPrices": [ # Fixed price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + }, + "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. + "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. + "fixedPrices": [ # Fixed price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + }, + "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. + "reservePricePerBuyers": [ # Reserve price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + "privateAuctionId": "A String", # Id of the corresponding private auction. + }, + "description": "A String", # Description for the proposed terms of the deal. + }, "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) "inventoryDescription": "A String", # Description for the deal terms. (updatable) + "productId": "A String", # The product-id from which this deal was created. (readonly, except on create) }, ], - "orderRevisionNumber": "A String", # The last known revision number for the order. - "order": { # Represents an order in the marketplace. An order is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in an order can have one of the following setting: # If specified, also updates the order in the batch transaction. This is useful when the order and the deals need to be updated in one transaction. + "proposal": { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting: # If specified, also updates the proposal in the batch transaction. This is useful when the proposal and the deals need to be updated in one transaction. # # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller. - "orderId": "A String", # The unique id of the order. (readonly). - "kind": "adexchangebuyer#marketplaceOrder", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceOrder". - "seller": { # Reference to the seller on the order. (readonly, except on create) - "subAccountId": "A String", # Optional sub-account id for the seller. - "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer. - }, - "name": "A String", # The name for the order (updatable) + "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal". + "proposalState": "A String", # The current state of the proposal. (readonly) + "name": "A String", # The name for the proposal (updatable) "buyerPrivateData": { # Private data for buyer. (hidden from seller). "referenceId": "A String", "referencePayload": "A String", }, - "billedBuyer": { # Reference to the buyer that will get billed for this order. (readonly) + "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly) "accountId": "A String", # Adx account id of the buyer. }, - "labels": [ # List of labels associated with the order. (readonly) + "labels": [ # List of labels associated with the proposal. (readonly) { "createTimeMs": "A String", # The creation time (in ms since epoch) for the label. "deprecatedMarketplaceDealParty": { # Information about the party that created the label. @@ -937,15 +992,15 @@

Method Details

}, "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party. "subAccountId": "A String", # Optional sub-account id for the seller. - "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the offer. + "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. }, }, "label": "A String", # The label to use. "accountId": "A String", # The accountId of the party that created the label. }, ], - "originatorRole": "A String", # Indicates whether the buyer/seller created the offer.(readonly) - "revisionTimeMs": "A String", # The time (ms since epoch) when the order was last revised (readonly). + "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly) + "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly). "sellerContacts": [ # Optional contact information for the seller (buyer-readonly). { "email": "A String", # Email address of the contact. @@ -953,16 +1008,21 @@

Method Details

}, ], "lastUpdaterRole": "A String", - "orderState": "A String", # The current state of the order. (readonly) - "hasSellerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (buyer-readonly) - "isRenegotiating": True or False, # True if the order is being renegotiated (readonly). - "buyer": { # Reference to the buyer on the order. (readonly, except on create) + "proposalId": "A String", # The unique id of the proposal. (readonly). + "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create). + "revisionNumber": "A String", # The revision number for the proposal (readonly). + "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly) + "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly). + "buyer": { # Reference to the buyer on the proposal. (readonly, except on create) "accountId": "A String", # Adx account id of the buyer. }, - "hasBuyerSignedOff": True or False, # When an order is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the order can be finalized by the seller. (seller-readonly) - "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this order. (readonly) - "revisionNumber": "A String", # The revision number for the order (readonly). - "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the order or left a comment. (readonly) + "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly) + "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly) + "seller": { # Reference to the seller on the proposal. (readonly, except on create) + "subAccountId": "A String", # Optional sub-account id for the seller. + "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product. + }, + "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly) "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly) { "email": "A String", # Email address of the contact. @@ -970,7 +1030,8 @@

Method Details

}, ], }, - "updateAction": "A String", # Indicates an optional action to take on the order + "proposalRevisionNumber": "A String", # The last known revision number for the proposal. + "updateAction": "A String", # Indicates an optional action to take on the proposal } @@ -978,8 +1039,8 @@

Method Details

An object of the form: { - "deals": [ # List of all deals in the order after edit. - { # An order can contain multiple deals. A deal contains the terms and targeting information that is used for serving. + "deals": [ # List of all deals in the proposal after edit. + { # A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving. "deliveryControl": { # The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension. "frequencyCaps": [ { @@ -988,55 +1049,11 @@

Method Details

"maxImpressions": 42, }, ], + "creativeBlockingLevel": "A String", "deliveryRateType": "A String", }, - "orderId": "A String", "kind": "adexchangebuyer#marketplaceDeal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceDeal". - "terms": { # The negotiable terms of the deal. (updatable) - "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. - "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. - "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for offer. - }, - "description": "A String", # Description for the proposed terms of the deal. - "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. - "reservePricePerBuyers": [ # Reserve price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - "privateAuctionId": "A String", # Id of the corresponding private auction. - }, - "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. - "fixedPrices": [ # Fixed price for the specified buyer. - { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an offer can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. - "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). - "accountId": "A String", # Adx account id of the buyer. - }, - "price": { # The specified price - "currencyCode": "A String", # The currency code for the price. - "amountMicros": 3.14, # The CPM value in micros. - }, - }, - ], - }, - }, + "creativePreApprovalPolicy": "A String", # Specifies the creative pre-approval policy (buyer-readonly) "name": "A String", # The name of the deal. (updatable) "buyerPrivateData": { # Buyer private data (hidden from seller). "referenceId": "A String", @@ -1069,7 +1086,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -1100,7 +1117,7 @@

Method Details

"height": 42, # The height of the creative. }, ], - "size": { # For regular creative size type, specifies the size of the creative. + "size": { # For regular or video creative size type, specifies the size of the creative. "width": 42, # The width of the creative. "height": 42, # The height of the creative. }, @@ -1111,7 +1128,7 @@

Method Details

"key": "A String", # The key representing the shared targeting criterion. }, ], - "offerId": "A String", # The offer-id from which this deal was created. (readonly, except on create) + "productRevisionNumber": "A String", # The revision number of the product that the deal was created from (readonly, except on create) "dealId": "A String", # A unique deal=id for the deal (readonly). "sellerContacts": [ # Optional Seller contact information for the deal (buyer-readonly) { @@ -1120,12 +1137,68 @@

Method Details

}, ], "webPropertyCode": "A String", + "proposalId": "A String", "flightStartTimeMs": "A String", # Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable) - "offerRevisionNumber": "A String", # The revision number of the offer that the deal was created from (readonly, except on create) + "terms": { # The negotiable terms of the deal. (updatable) + "brandingType": "A String", # Visibilty of the URL in bid requests. + "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller. + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller. + "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals. + "fixedPrices": [ # Fixed price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + }, + "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals. + "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy. + "fixedPrices": [ # Fixed price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product. + }, + "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals. + "reservePricePerBuyers": [ # Reserve price for the specified buyer. + { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set. + "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer). + "accountId": "A String", # Adx account id of the buyer. + }, + "price": { # The specified price + "pricingType": "A String", # The pricing type for the deal/product. + "currencyCode": "A String", # The currency code for the price. + "amountMicros": 3.14, # The price value in micros. + }, + }, + ], + "privateAuctionId": "A String", # Id of the corresponding private auction. + }, + "description": "A String", # Description for the proposed terms of the deal. + }, "creationTimeMs": "A String", # The time (ms since epoch) of the deal creation. (readonly) "lastUpdateTimeMs": "A String", # The time (ms since epoch) when the deal was last updated. (readonly) "externalDealId": "A String", # The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly) "inventoryDescription": "A String", # Description for the deal terms. (updatable) + "productId": "A String", # The product-id from which this deal was created. (readonly, except on create) }, ], }
diff --git a/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html b/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html index 63399035410..73679b5c1da 100644 --- a/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html +++ b/docs/dyn/adexchangebuyer_v1_4.marketplacenotes.html @@ -75,29 +75,29 @@

Ad Exchange Buyer API . marketplacenotes

Instance Methods

- insert(orderId, body)

-

Add notes to the order

+ insert(proposalId, body)

+

Add notes to the proposal

- list(orderId)

-

Get all the notes associated with an order

+ list(proposalId)

+

Get all the notes associated with a proposal

Method Details

- insert(orderId, body) -
Add notes to the order
+    insert(proposalId, body)
+  
Add notes to the proposal
 
 Args:
-  orderId: string, The orderId to add notes for. (required)
+  proposalId: string, The proposalId to add notes for. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "notes": [ # The list of notes to add.
-      { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
-        "orderId": "A String", # The order_id that a note is attached to. (readonly)
+      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
         "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
-        "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
+        "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
         "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
         "note": "A String", # The actual note to attach. (readonly, except on create)
+        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
         "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
         "noteId": "A String", # The unique id for the note. (readonly)
         "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
@@ -111,12 +111,12 @@ 

Method Details

{ "notes": [ - { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. - "orderId": "A String", # The order_id that a note is attached to. (readonly) + { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number. "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote". - "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create) + "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create) "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create) "note": "A String", # The actual note to attach. (readonly, except on create) + "proposalId": "A String", # The proposalId that a note is attached to. (readonly) "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly) "noteId": "A String", # The unique id for the note. (readonly) "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly) @@ -126,23 +126,23 @@

Method Details

- list(orderId) -
Get all the notes associated with an order
+    list(proposalId)
+  
Get all the notes associated with a proposal
 
 Args:
-  orderId: string, The orderId to get notes for. (required)
+  proposalId: string, The proposalId to get notes for. (required)
 
 Returns:
   An object of the form:
 
     {
     "notes": [ # The list of matching notes.
-      { # An order is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
-        "orderId": "A String", # The order_id that a note is attached to. (readonly)
+      { # A proposal is associated with a bunch of notes which may optionally be associated with a deal and/or revision number.
         "kind": "adexchangebuyer#marketplaceNote", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#marketplaceNote".
-        "orderRevisionNumber": "A String", # If the note is associated with an order revision number, then store that here. (readonly, except on create)
+        "proposalRevisionNumber": "A String", # If the note is associated with a proposal revision number, then store that here. (readonly, except on create)
         "dealId": "A String", # Notes can optionally be associated with a deal. (readonly, except on create)
         "note": "A String", # The actual note to attach. (readonly, except on create)
+        "proposalId": "A String", # The proposalId that a note is attached to. (readonly)
         "creatorRole": "A String", # The role of the person (buyer/seller) creating the note. (readonly)
         "noteId": "A String", # The unique id for the note. (readonly)
         "timestampMs": "A String", # The timestamp (ms since epoch) that this note was created. (readonly)
diff --git a/docs/dyn/adexchangebuyer_v1_4.pretargetingConfig.html b/docs/dyn/adexchangebuyer_v1_4.pretargetingConfig.html
index 62982bc1e78..337b688b2c0 100644
--- a/docs/dyn/adexchangebuyer_v1_4.pretargetingConfig.html
+++ b/docs/dyn/adexchangebuyer_v1_4.pretargetingConfig.html
@@ -121,6 +121,13 @@ 

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -202,6 +209,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -277,6 +291,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -361,6 +382,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -446,6 +474,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -521,6 +556,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -603,6 +645,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", @@ -678,6 +727,13 @@

Method Details

"platforms": [ # Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. "A String", ], + "videoPlayerSizes": [ # Video requests satisfying any of these player size constraints will match. + { + "minWidth": "A String", # The minimum player width in pixels. Leave this field blank to match any player width. + "aspectRatio": "A String", # The type of aspect ratio. Leave this field blank to match all aspect ratios. + "minHeight": "A String", # The minimum player height in pixels. Leave this field blank to match any player height. + }, + ], "configId": "A String", # The config id; generated automatically. Leave this field blank for insert requests. "excludedVerticals": [ # Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. "A String", diff --git a/docs/dyn/adexchangebuyer_v1_4.products.html b/docs/dyn/adexchangebuyer_v1_4.products.html new file mode 100644 index 00000000000..4677e705f86 --- /dev/null +++ b/docs/dyn/adexchangebuyer_v1_4.products.html @@ -0,0 +1,442 @@ + + + +

Ad Exchange Buyer API . products

+

Instance Methods

+

+ get(productId)

+

Gets the requested product by id.

+

+ search(pqlQuery=None)

+

Gets the requested product.

+

Method Details

+
+ get(productId) +
Gets the requested product by id.
+
+Args:
+  productId: string, The id for the product to get the head revision for. (required)
+
+Returns:
+  An object of the form:
+
+    { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
+      #
+      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+    "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+    "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
+    "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
+      {
+        "inclusions": [ # The list of value to include as part of the targeting.
+          {
+            "longValue": "A String", # The long value to exclude/include.
+            "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+              "dayParts": [
+                {
+                  "dayOfWeek": "A String",
+                  "endHour": 42,
+                  "startMinute": 42,
+                  "endMinute": 42,
+                  "startHour": 42,
+                },
+              ],
+              "timeZoneType": "A String",
+            },
+            "creativeSizeValue": { # The creative size value to exclude/include.
+              "creativeSizeType": "A String", # The Creative size type.
+              "companionSizes": [ # For video size type, the list of companion sizes.
+                {
+                  "width": 42, # The width of the creative.
+                  "height": 42, # The height of the creative.
+                },
+              ],
+              "size": { # For regular or video creative size type, specifies the size of the creative.
+                "width": 42, # The width of the creative.
+                "height": 42, # The height of the creative.
+              },
+            },
+            "stringValue": "A String", # The string value to exclude/include.
+          },
+        ],
+        "exclusions": [ # The list of values to exclude from targeting.
+          {
+            "longValue": "A String", # The long value to exclude/include.
+            "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+              "dayParts": [
+                {
+                  "dayOfWeek": "A String",
+                  "endHour": 42,
+                  "startMinute": 42,
+                  "endMinute": 42,
+                  "startHour": 42,
+                },
+              ],
+              "timeZoneType": "A String",
+            },
+            "creativeSizeValue": { # The creative size value to exclude/include.
+              "creativeSizeType": "A String", # The Creative size type.
+              "companionSizes": [ # For video size type, the list of companion sizes.
+                {
+                  "width": 42, # The width of the creative.
+                  "height": 42, # The height of the creative.
+                },
+              ],
+              "size": { # For regular or video creative size type, specifies the size of the creative.
+                "width": 42, # The width of the creative.
+                "height": 42, # The height of the creative.
+              },
+            },
+            "stringValue": "A String", # The string value to exclude/include.
+          },
+        ],
+        "key": "A String", # The key representing the shared targeting criterion.
+      },
+    ],
+    "terms": { # The negotiable terms of the deal (buyer-readonly)
+      "brandingType": "A String", # Visibilty of the URL in bid requests.
+      "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+        "pricingType": "A String", # The pricing type for the deal/product.
+        "currencyCode": "A String", # The currency code for the price.
+        "amountMicros": 3.14, # The price value in micros.
+      },
+      "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+      "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+        "fixedPrices": [ # Fixed price for the specified buyer.
+          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+              "accountId": "A String", # Adx account id of the buyer.
+            },
+            "price": { # The specified price
+              "pricingType": "A String", # The pricing type for the deal/product.
+              "currencyCode": "A String", # The currency code for the price.
+              "amountMicros": 3.14, # The price value in micros.
+            },
+          },
+        ],
+      },
+      "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+        "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+        "fixedPrices": [ # Fixed price for the specified buyer.
+          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+              "accountId": "A String", # Adx account id of the buyer.
+            },
+            "price": { # The specified price
+              "pricingType": "A String", # The pricing type for the deal/product.
+              "currencyCode": "A String", # The currency code for the price.
+              "amountMicros": 3.14, # The price value in micros.
+            },
+          },
+        ],
+        "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+      },
+      "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+        "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+          { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+            "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+              "accountId": "A String", # Adx account id of the buyer.
+            },
+            "price": { # The specified price
+              "pricingType": "A String", # The pricing type for the deal/product.
+              "currencyCode": "A String", # The currency code for the price.
+              "amountMicros": 3.14, # The price value in micros.
+            },
+          },
+        ],
+        "privateAuctionId": "A String", # Id of the corresponding private auction.
+      },
+      "description": "A String", # Description for the proposed terms of the deal.
+    },
+    "name": "A String", # The name for this product as set by the seller. (buyer-readonly)
+    "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+    "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
+    "labels": [ # Optional List of labels for the product (optional, buyer-readonly).
+      {
+        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+            "accountId": "A String", # Adx account id of the buyer.
+          },
+          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+            "subAccountId": "A String", # Optional sub-account id for the seller.
+            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+          },
+        },
+        "label": "A String", # The label to use.
+        "accountId": "A String", # The accountId of the party that created the label.
+      },
+    ],
+    "seller": { # Information about the seller that created this product (readonly, except on create)
+      "subAccountId": "A String", # Optional sub-account id for the seller.
+      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+    },
+    "webPropertyCode": "A String",
+    "state": "A String", # The state of the product. (buyer-readonly)
+    "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
+    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+    "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
+    "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
+    "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
+    "revisionNumber": "A String", # The revision number of the product. (readonly)
+    "productId": "A String", # The unique id for the product (readonly)
+  }
+
+ +
+ search(pqlQuery=None) +
Gets the requested product.
+
+Args:
+  pqlQuery: string, The pql query used to query for products.
+
+Returns:
+  An object of the form:
+
+    {
+    "products": [ # The returned list of products.
+      { # A product is segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps buyer know more about the inventory. Each field in a product can have one of the following setting:
+          #
+          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+        "creatorContacts": [ # Optional contact information for the creator of this product. (buyer-readonly)
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+        "kind": "adexchangebuyer#product", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#product".
+        "sharedTargetings": [ # Targeting that is shared between the buyer and the seller. Each targeting criteria has a specified key and for each key there is a list of inclusion value or exclusion values. (buyer-readonly)
+          {
+            "inclusions": [ # The list of value to include as part of the targeting.
+              {
+                "longValue": "A String", # The long value to exclude/include.
+                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+                  "dayParts": [
+                    {
+                      "dayOfWeek": "A String",
+                      "endHour": 42,
+                      "startMinute": 42,
+                      "endMinute": 42,
+                      "startHour": 42,
+                    },
+                  ],
+                  "timeZoneType": "A String",
+                },
+                "creativeSizeValue": { # The creative size value to exclude/include.
+                  "creativeSizeType": "A String", # The Creative size type.
+                  "companionSizes": [ # For video size type, the list of companion sizes.
+                    {
+                      "width": 42, # The width of the creative.
+                      "height": 42, # The height of the creative.
+                    },
+                  ],
+                  "size": { # For regular or video creative size type, specifies the size of the creative.
+                    "width": 42, # The width of the creative.
+                    "height": 42, # The height of the creative.
+                  },
+                },
+                "stringValue": "A String", # The string value to exclude/include.
+              },
+            ],
+            "exclusions": [ # The list of values to exclude from targeting.
+              {
+                "longValue": "A String", # The long value to exclude/include.
+                "dayPartTargetingValue": { # The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING.
+                  "dayParts": [
+                    {
+                      "dayOfWeek": "A String",
+                      "endHour": 42,
+                      "startMinute": 42,
+                      "endMinute": 42,
+                      "startHour": 42,
+                    },
+                  ],
+                  "timeZoneType": "A String",
+                },
+                "creativeSizeValue": { # The creative size value to exclude/include.
+                  "creativeSizeType": "A String", # The Creative size type.
+                  "companionSizes": [ # For video size type, the list of companion sizes.
+                    {
+                      "width": 42, # The width of the creative.
+                      "height": 42, # The height of the creative.
+                    },
+                  ],
+                  "size": { # For regular or video creative size type, specifies the size of the creative.
+                    "width": 42, # The width of the creative.
+                    "height": 42, # The height of the creative.
+                  },
+                },
+                "stringValue": "A String", # The string value to exclude/include.
+              },
+            ],
+            "key": "A String", # The key representing the shared targeting criterion.
+          },
+        ],
+        "terms": { # The negotiable terms of the deal (buyer-readonly)
+          "brandingType": "A String", # Visibilty of the URL in bid requests.
+          "estimatedGrossSpend": { # Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller.
+            "pricingType": "A String", # The pricing type for the deal/product.
+            "currencyCode": "A String", # The currency code for the price.
+            "amountMicros": 3.14, # The price value in micros.
+          },
+          "estimatedImpressionsPerDay": "A String", # Non-binding estimate of the impressions served per day Can be set by buyer or seller.
+          "nonGuaranteedFixedPriceTerms": { # The terms for non-guaranteed fixed price deals.
+            "fixedPrices": [ # Fixed price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+                  "accountId": "A String", # Adx account id of the buyer.
+                },
+                "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
+                  "currencyCode": "A String", # The currency code for the price.
+                  "amountMicros": 3.14, # The price value in micros.
+                },
+              },
+            ],
+          },
+          "guaranteedFixedPriceTerms": { # The terms for guaranteed fixed price deals.
+            "guaranteedImpressions": "A String", # Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
+            "fixedPrices": [ # Fixed price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+                  "accountId": "A String", # Adx account id of the buyer.
+                },
+                "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
+                  "currencyCode": "A String", # The currency code for the price.
+                  "amountMicros": 3.14, # The price value in micros.
+                },
+              },
+            ],
+            "guaranteedLooks": "A String", # Count of guaranteed looks. Required for deal, optional for product.
+          },
+          "nonGuaranteedAuctionTerms": { # The terms for non-guaranteed auction deals.
+            "reservePricePerBuyers": [ # Reserve price for the specified buyer.
+              { # Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in an product can become [0,1] deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.
+                "buyer": { # The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer).
+                  "accountId": "A String", # Adx account id of the buyer.
+                },
+                "price": { # The specified price
+                  "pricingType": "A String", # The pricing type for the deal/product.
+                  "currencyCode": "A String", # The currency code for the price.
+                  "amountMicros": 3.14, # The price value in micros.
+                },
+              },
+            ],
+            "privateAuctionId": "A String", # Id of the corresponding private auction.
+          },
+          "description": "A String", # Description for the proposed terms of the deal.
+        },
+        "name": "A String", # The name for this product as set by the seller. (buyer-readonly)
+        "syndicationProduct": "A String", # The syndication product associated with the deal. (readonly, except on create)
+        "flightEndTimeMs": "A String", # The proposed end time for the deal (ms since epoch) (buyer-readonly)
+        "labels": [ # Optional List of labels for the product (optional, buyer-readonly).
+          {
+            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+                "accountId": "A String", # Adx account id of the buyer.
+              },
+              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+                "subAccountId": "A String", # Optional sub-account id for the seller.
+                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+              },
+            },
+            "label": "A String", # The label to use.
+            "accountId": "A String", # The accountId of the party that created the label.
+          },
+        ],
+        "seller": { # Information about the seller that created this product (readonly, except on create)
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+        "webPropertyCode": "A String",
+        "state": "A String", # The state of the product. (buyer-readonly)
+        "hasCreatorSignedOff": True or False, # If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.
+        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+        "flightStartTimeMs": "A String", # Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)
+        "creationTimeMs": "A String", # Creation time in ms. since epoch (readonly)
+        "lastUpdateTimeMs": "A String", # Time of last update in ms. since epoch (readonly)
+        "revisionNumber": "A String", # The revision number of the product. (readonly)
+        "productId": "A String", # The unique id for the product (readonly)
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/adexchangebuyer_v1_4.proposals.html b/docs/dyn/adexchangebuyer_v1_4.proposals.html new file mode 100644 index 00000000000..c1e5e092510 --- /dev/null +++ b/docs/dyn/adexchangebuyer_v1_4.proposals.html @@ -0,0 +1,673 @@ + + + +

Ad Exchange Buyer API . proposals

+

Instance Methods

+

+ get(proposalId)

+

Get a proposal given its id

+

+ insert(body)

+

Create the given list of proposals

+

+ patch(proposalId, revisionNumber, updateAction, body)

+

Update the given proposal. This method supports patch semantics.

+

+ search(pqlQuery=None)

+

Search for proposals using pql query

+

+ update(proposalId, revisionNumber, updateAction, body)

+

Update the given proposal

+

Method Details

+
+ get(proposalId) +
Get a proposal given its id
+
+Args:
+  proposalId: string, Id of the proposal to retrieve. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+      #
+      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+    "proposalState": "A String", # The current state of the proposal. (readonly)
+    "name": "A String", # The name for the proposal (updatable)
+    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+      "referenceId": "A String",
+      "referencePayload": "A String",
+    },
+    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "labels": [ # List of labels associated with the proposal. (readonly)
+      {
+        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+            "accountId": "A String", # Adx account id of the buyer.
+          },
+          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+            "subAccountId": "A String", # Optional sub-account id for the seller.
+            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+          },
+        },
+        "label": "A String", # The label to use.
+        "accountId": "A String", # The accountId of the party that created the label.
+      },
+    ],
+    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+    "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+    "lastUpdaterRole": "A String",
+    "proposalId": "A String", # The unique id of the proposal. (readonly).
+    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+    "revisionNumber": "A String", # The revision number for the proposal (readonly).
+    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+      "subAccountId": "A String", # Optional sub-account id for the seller.
+      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+    },
+    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+    "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+  }
+
+ +
+ insert(body) +
Create the given list of proposals
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "webPropertyCode": "A String",
+    "proposals": [ # The list of proposals to create.
+      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+          #
+          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+        "proposalState": "A String", # The current state of the proposal. (readonly)
+        "name": "A String", # The name for the proposal (updatable)
+        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+          "referenceId": "A String",
+          "referencePayload": "A String",
+        },
+        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "labels": [ # List of labels associated with the proposal. (readonly)
+          {
+            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+                "accountId": "A String", # Adx account id of the buyer.
+              },
+              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+                "subAccountId": "A String", # Optional sub-account id for the seller.
+                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+              },
+            },
+            "label": "A String", # The label to use.
+            "accountId": "A String", # The accountId of the party that created the label.
+          },
+        ],
+        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+        "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+        "lastUpdaterRole": "A String",
+        "proposalId": "A String", # The unique id of the proposal. (readonly).
+        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+        "revisionNumber": "A String", # The revision number for the proposal (readonly).
+        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+        "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "proposals": [ # The list of proposals successfully created.
+      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+          #
+          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+        "proposalState": "A String", # The current state of the proposal. (readonly)
+        "name": "A String", # The name for the proposal (updatable)
+        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+          "referenceId": "A String",
+          "referencePayload": "A String",
+        },
+        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "labels": [ # List of labels associated with the proposal. (readonly)
+          {
+            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+                "accountId": "A String", # Adx account id of the buyer.
+              },
+              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+                "subAccountId": "A String", # Optional sub-account id for the seller.
+                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+              },
+            },
+            "label": "A String", # The label to use.
+            "accountId": "A String", # The accountId of the party that created the label.
+          },
+        ],
+        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+        "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+        "lastUpdaterRole": "A String",
+        "proposalId": "A String", # The unique id of the proposal. (readonly).
+        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+        "revisionNumber": "A String", # The revision number for the proposal (readonly).
+        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+        "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+      },
+    ],
+  }
+
+ +
+ patch(proposalId, revisionNumber, updateAction, body) +
Update the given proposal. This method supports patch semantics.
+
+Args:
+  proposalId: string, The proposal id to update. (required)
+  revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
+  updateAction: string, The proposed action to take on the proposal. (required)
+    Allowed values
+      accept - 
+      cancel - 
+      propose - 
+      unknownAction - 
+      updateFinalized - 
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+    # 
+    # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+  "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+  "proposalState": "A String", # The current state of the proposal. (readonly)
+  "name": "A String", # The name for the proposal (updatable)
+  "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+    "referenceId": "A String",
+    "referencePayload": "A String",
+  },
+  "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+    "accountId": "A String", # Adx account id of the buyer.
+  },
+  "labels": [ # List of labels associated with the proposal. (readonly)
+    {
+      "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+      "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+        "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+      },
+      "label": "A String", # The label to use.
+      "accountId": "A String", # The accountId of the party that created the label.
+    },
+  ],
+  "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+  "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+  "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+    {
+      "email": "A String", # Email address of the contact.
+      "name": "A String", # The name of the contact.
+    },
+  ],
+  "lastUpdaterRole": "A String",
+  "proposalId": "A String", # The unique id of the proposal. (readonly).
+  "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+  "revisionNumber": "A String", # The revision number for the proposal (readonly).
+  "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+  "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+  "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+    "accountId": "A String", # Adx account id of the buyer.
+  },
+  "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+  "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+  "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+    "subAccountId": "A String", # Optional sub-account id for the seller.
+    "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+  },
+  "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+  "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+    {
+      "email": "A String", # Email address of the contact.
+      "name": "A String", # The name of the contact.
+    },
+  ],
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+      #
+      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+    "proposalState": "A String", # The current state of the proposal. (readonly)
+    "name": "A String", # The name for the proposal (updatable)
+    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+      "referenceId": "A String",
+      "referencePayload": "A String",
+    },
+    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "labels": [ # List of labels associated with the proposal. (readonly)
+      {
+        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+            "accountId": "A String", # Adx account id of the buyer.
+          },
+          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+            "subAccountId": "A String", # Optional sub-account id for the seller.
+            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+          },
+        },
+        "label": "A String", # The label to use.
+        "accountId": "A String", # The accountId of the party that created the label.
+      },
+    ],
+    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+    "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+    "lastUpdaterRole": "A String",
+    "proposalId": "A String", # The unique id of the proposal. (readonly).
+    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+    "revisionNumber": "A String", # The revision number for the proposal (readonly).
+    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+      "subAccountId": "A String", # Optional sub-account id for the seller.
+      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+    },
+    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+    "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+  }
+
+ +
+ search(pqlQuery=None) +
Search for proposals using pql query
+
+Args:
+  pqlQuery: string, Query string to retrieve specific proposals.
+
+Returns:
+  An object of the form:
+
+    {
+    "proposals": [ # The list of matching proposals.
+      { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+          #
+          # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+        "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+        "proposalState": "A String", # The current state of the proposal. (readonly)
+        "name": "A String", # The name for the proposal (updatable)
+        "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+          "referenceId": "A String",
+          "referencePayload": "A String",
+        },
+        "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "labels": [ # List of labels associated with the proposal. (readonly)
+          {
+            "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+            "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+              "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+                "accountId": "A String", # Adx account id of the buyer.
+              },
+              "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+                "subAccountId": "A String", # Optional sub-account id for the seller.
+                "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+              },
+            },
+            "label": "A String", # The label to use.
+            "accountId": "A String", # The accountId of the party that created the label.
+          },
+        ],
+        "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+        "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+        "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+        "lastUpdaterRole": "A String",
+        "proposalId": "A String", # The unique id of the proposal. (readonly).
+        "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+        "revisionNumber": "A String", # The revision number for the proposal (readonly).
+        "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+        "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+        "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+        "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+        "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+        "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+        "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+          {
+            "email": "A String", # Email address of the contact.
+            "name": "A String", # The name of the contact.
+          },
+        ],
+      },
+    ],
+  }
+
+ +
+ update(proposalId, revisionNumber, updateAction, body) +
Update the given proposal
+
+Args:
+  proposalId: string, The proposal id to update. (required)
+  revisionNumber: string, The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision. (required)
+  updateAction: string, The proposed action to take on the proposal. (required)
+    Allowed values
+      accept - 
+      cancel - 
+      propose - 
+      unknownAction - 
+      updateFinalized - 
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+    # 
+    # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+  "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+  "proposalState": "A String", # The current state of the proposal. (readonly)
+  "name": "A String", # The name for the proposal (updatable)
+  "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+    "referenceId": "A String",
+    "referencePayload": "A String",
+  },
+  "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+    "accountId": "A String", # Adx account id of the buyer.
+  },
+  "labels": [ # List of labels associated with the proposal. (readonly)
+    {
+      "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+      "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+        "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+          "accountId": "A String", # Adx account id of the buyer.
+        },
+        "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+          "subAccountId": "A String", # Optional sub-account id for the seller.
+          "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+        },
+      },
+      "label": "A String", # The label to use.
+      "accountId": "A String", # The accountId of the party that created the label.
+    },
+  ],
+  "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+  "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+  "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+    {
+      "email": "A String", # Email address of the contact.
+      "name": "A String", # The name of the contact.
+    },
+  ],
+  "lastUpdaterRole": "A String",
+  "proposalId": "A String", # The unique id of the proposal. (readonly).
+  "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+  "revisionNumber": "A String", # The revision number for the proposal (readonly).
+  "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+  "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+  "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+    "accountId": "A String", # Adx account id of the buyer.
+  },
+  "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+  "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+  "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+    "subAccountId": "A String", # Optional sub-account id for the seller.
+    "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+  },
+  "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+  "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+    {
+      "email": "A String", # Email address of the contact.
+      "name": "A String", # The name of the contact.
+    },
+  ],
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Each field in a proposal can have one of the following setting:
+      #
+      # (readonly) - It is an error to try and set this field. (buyer-readonly) - Only the seller can set this field. (seller-readonly) - Only the buyer can set this field. (updatable) - The field is updatable at all times by either buyer or the seller.
+    "kind": "adexchangebuyer#proposal", # Identifies what kind of resource this is. Value: the fixed string "adexchangebuyer#proposal".
+    "proposalState": "A String", # The current state of the proposal. (readonly)
+    "name": "A String", # The name for the proposal (updatable)
+    "buyerPrivateData": { # Private data for buyer. (hidden from seller).
+      "referenceId": "A String",
+      "referencePayload": "A String",
+    },
+    "billedBuyer": { # Reference to the buyer that will get billed for this proposal. (readonly)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "labels": [ # List of labels associated with the proposal. (readonly)
+      {
+        "createTimeMs": "A String", # The creation time (in ms since epoch) for the label.
+        "deprecatedMarketplaceDealParty": { # Information about the party that created the label.
+          "buyer": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal-party.
+            "accountId": "A String", # Adx account id of the buyer.
+          },
+          "seller": { # The buyer/seller associated with the deal. One of buyer/seller is specified for a deal party.
+            "subAccountId": "A String", # Optional sub-account id for the seller.
+            "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+          },
+        },
+        "label": "A String", # The label to use.
+        "accountId": "A String", # The accountId of the party that created the label.
+      },
+    ],
+    "originatorRole": "A String", # Indicates whether the buyer/seller created the proposal.(readonly)
+    "revisionTimeMs": "A String", # The time (ms since epoch) when the proposal was last revised (readonly).
+    "sellerContacts": [ # Optional contact information for the seller (buyer-readonly).
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+    "lastUpdaterRole": "A String",
+    "proposalId": "A String", # The unique id of the proposal. (readonly).
+    "inventorySource": "A String", # What exchange will provide this inventory (readonly, except on create).
+    "revisionNumber": "A String", # The revision number for the proposal (readonly).
+    "hasSellerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)
+    "isRenegotiating": True or False, # True if the proposal is being renegotiated (readonly).
+    "buyer": { # Reference to the buyer on the proposal. (readonly, except on create)
+      "accountId": "A String", # Adx account id of the buyer.
+    },
+    "hasBuyerSignedOff": True or False, # When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)
+    "isSetupComplete": True or False, # True, if the buyside inventory setup is complete for this proposal. (readonly)
+    "seller": { # Reference to the seller on the proposal. (readonly, except on create)
+      "subAccountId": "A String", # Optional sub-account id for the seller.
+      "accountId": "A String", # The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.
+    },
+    "lastUpdaterOrCommentorRole": "A String", # The role of the last user that either updated the proposal or left a comment. (readonly)
+    "buyerContacts": [ # Optional contact information fort the buyer. (seller-readonly)
+      {
+        "email": "A String", # Email address of the contact.
+        "name": "A String", # The name of the contact.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsense_v1_4.accounts.adclients.html b/docs/dyn/adsense_v1_4.accounts.adclients.html index 08a09baeafa..bace8d8c643 100644 --- a/docs/dyn/adsense_v1_4.accounts.adclients.html +++ b/docs/dyn/adsense_v1_4.accounts.adclients.html @@ -99,10 +99,9 @@

Method Details

{ "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient. - "supportsReporting": True or False, # Whether this ad client supports being reported on. - "arcReviewMode": "A String", # ARC review mode this ad client is in. Empty if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PRE_REVIEW. - "arcOptIn": True or False, # Whether this ad client is opted in to ARC. "id": "A String", # Unique identifier of this ad client. + "arcOptIn": True or False, # Whether this ad client is opted in to ARC. + "supportsReporting": True or False, # Whether this ad client supports being reported on. }, ], "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients. diff --git a/docs/dyn/adsense_v1_4.accounts.adunits.customchannels.html b/docs/dyn/adsense_v1_4.accounts.adunits.customchannels.html index 5851d9a6cef..c30d96578cc 100644 --- a/docs/dyn/adsense_v1_4.accounts.adunits.customchannels.html +++ b/docs/dyn/adsense_v1_4.accounts.adunits.customchannels.html @@ -102,7 +102,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. diff --git a/docs/dyn/adsense_v1_4.accounts.adunits.html b/docs/dyn/adsense_v1_4.accounts.adunits.html index 4395b0c77bb..b720c12376f 100644 --- a/docs/dyn/adsense_v1_4.accounts.adunits.html +++ b/docs/dyn/adsense_v1_4.accounts.adunits.html @@ -114,14 +114,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -131,7 +131,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -200,14 +200,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -217,7 +217,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. diff --git a/docs/dyn/adsense_v1_4.accounts.customchannels.adunits.html b/docs/dyn/adsense_v1_4.accounts.customchannels.adunits.html index ab720d6a2cd..e982c350953 100644 --- a/docs/dyn/adsense_v1_4.accounts.customchannels.adunits.html +++ b/docs/dyn/adsense_v1_4.accounts.customchannels.adunits.html @@ -109,14 +109,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -126,7 +126,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. diff --git a/docs/dyn/adsense_v1_4.accounts.customchannels.html b/docs/dyn/adsense_v1_4.accounts.customchannels.html index 4c2dde557f8..0d1bed56ae5 100644 --- a/docs/dyn/adsense_v1_4.accounts.customchannels.html +++ b/docs/dyn/adsense_v1_4.accounts.customchannels.html @@ -105,7 +105,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. @@ -135,7 +135,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. diff --git a/docs/dyn/adsense_v1_4.accounts.html b/docs/dyn/adsense_v1_4.accounts.html index a1f0afa833f..30d4a231d14 100644 --- a/docs/dyn/adsense_v1_4.accounts.html +++ b/docs/dyn/adsense_v1_4.accounts.html @@ -139,6 +139,7 @@

Method Details

"kind": "adsense#account", # Kind of resource this is, in this case adsense#account. "premium": True or False, # Whether this account is premium. "name": "A String", # Name of this account. + "creation_time": "A String", "subAccounts": [ # Sub accounts of the this account. # Object with schema name: Account ], @@ -165,6 +166,7 @@

Method Details

"kind": "adsense#account", # Kind of resource this is, in this case adsense#account. "premium": True or False, # Whether this account is premium. "name": "A String", # Name of this account. + "creation_time": "A String", "subAccounts": [ # Sub accounts of the this account. # Object with schema name: Account ], diff --git a/docs/dyn/adsense_v1_4.adclients.html b/docs/dyn/adsense_v1_4.adclients.html index 1afb8961bc9..f30422f9e44 100644 --- a/docs/dyn/adsense_v1_4.adclients.html +++ b/docs/dyn/adsense_v1_4.adclients.html @@ -98,10 +98,9 @@

Method Details

{ "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient. - "supportsReporting": True or False, # Whether this ad client supports being reported on. - "arcReviewMode": "A String", # ARC review mode this ad client is in. Empty if the client is not opted in to ARC. Possible values: POST_REVIEW, AUTOMATIC_PRE_REVIEW. - "arcOptIn": True or False, # Whether this ad client is opted in to ARC. "id": "A String", # Unique identifier of this ad client. + "arcOptIn": True or False, # Whether this ad client is opted in to ARC. + "supportsReporting": True or False, # Whether this ad client supports being reported on. }, ], "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients. diff --git a/docs/dyn/adsense_v1_4.adunits.customchannels.html b/docs/dyn/adsense_v1_4.adunits.customchannels.html index 7ee2cbb91a0..1c66f4cc795 100644 --- a/docs/dyn/adsense_v1_4.adunits.customchannels.html +++ b/docs/dyn/adsense_v1_4.adunits.customchannels.html @@ -101,7 +101,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. diff --git a/docs/dyn/adsense_v1_4.adunits.html b/docs/dyn/adsense_v1_4.adunits.html index 303c688816e..8f92a18331f 100644 --- a/docs/dyn/adsense_v1_4.adunits.html +++ b/docs/dyn/adsense_v1_4.adunits.html @@ -113,14 +113,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -130,7 +130,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -197,14 +197,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -214,7 +214,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. diff --git a/docs/dyn/adsense_v1_4.customchannels.adunits.html b/docs/dyn/adsense_v1_4.customchannels.adunits.html index 665efe66691..8ad228fd04d 100644 --- a/docs/dyn/adsense_v1_4.customchannels.adunits.html +++ b/docs/dyn/adsense_v1_4.customchannels.adunits.html @@ -108,14 +108,14 @@

Method Details

"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "feedAdsSettings": { # Settings specific to feed ads (AFF). + "feedAdsSettings": { # Settings specific to feed ads (AFF) - deprecated. "minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads. "frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries). "adPosition": "A String", # The position of the ads relative to the feed entries. "type": "A String", # The type of ads which should appear. }, "savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. @@ -125,7 +125,7 @@

Method Details

"size": "A String", # Size of this ad unit. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC) - deprecated. "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. diff --git a/docs/dyn/adsense_v1_4.customchannels.html b/docs/dyn/adsense_v1_4.customchannels.html index 255f7ab569d..a307c7b11ef 100644 --- a/docs/dyn/adsense_v1_4.customchannels.html +++ b/docs/dyn/adsense_v1_4.customchannels.html @@ -104,7 +104,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. @@ -133,7 +133,7 @@

Method Details

"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel. "code": "A String", # Code of this custom channel, not necessarily unique across ad clients. "targetingInfo": { # The targeting information of this custom channel, if activated. - "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. + "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads (deprecated)). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads (deprecated) are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS. "adsAppearOn": "A String", # The name used to describe this channel externally. "siteLanguage": "A String", # The language of the sites ads will be displayed on. "description": "A String", # The external description of the channel. diff --git a/docs/dyn/adsensehost_v4_1.accounts.adunits.html b/docs/dyn/adsensehost_v4_1.accounts.adunits.html index 167fa1e0a46..a7b0a7e0b29 100644 --- a/docs/dyn/adsensehost_v4_1.accounts.adunits.html +++ b/docs/dyn/adsensehost_v4_1.accounts.adunits.html @@ -121,7 +121,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -131,7 +131,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -177,7 +177,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -187,7 +187,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -250,7 +250,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -260,7 +260,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -297,7 +297,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -307,7 +307,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -358,7 +358,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -368,7 +368,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -431,7 +431,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -441,7 +441,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -478,7 +478,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -488,7 +488,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -532,7 +532,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -542,7 +542,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. @@ -579,7 +579,7 @@

Method Details

"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit. "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients. "name": "A String", # Name of this ad unit. - "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC). + "contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). "type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK. "backupOption": { # The backup option to be used in instances where no ad is available. "color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. @@ -589,7 +589,7 @@

Method Details

"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}. }, "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format. - "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC). + "mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC - deprecated). "scriptingLanguage": "A String", # The scripting language to use for this ad unit. "type": "A String", # Type of this ad unit. "markupLanguage": "A String", # The markup language to use for this ad unit. diff --git a/docs/dyn/adsensehost_v4_1.associationsessions.html b/docs/dyn/adsensehost_v4_1.associationsessions.html index 2bd44a514c4..6a3a3d530ce 100644 --- a/docs/dyn/adsensehost_v4_1.associationsessions.html +++ b/docs/dyn/adsensehost_v4_1.associationsessions.html @@ -90,8 +90,8 @@

Method Details

Allowed values AFC - AdSense For Content AFG - AdSense For Games - AFMC - AdSense For Mobile Content - AFS - AdSense For Search + AFMC - AdSense For Mobile Content - deprecated + AFS - AdSense For Search - deprecated AFV - AdSense For Video websiteUrl: string, The URL of the user's hosted website. (required) websiteLocale: string, The locale of the user's hosted website. @@ -102,7 +102,7 @@

Method Details

{ "status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR. - "productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC + "productCodes": [ # The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated) "A String", ], "kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession. @@ -127,7 +127,7 @@

Method Details

{ "status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR. - "productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC + "productCodes": [ # The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated) "A String", ], "kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession. diff --git a/docs/dyn/analytics_v3.data.ga.html b/docs/dyn/analytics_v3.data.ga.html index 5f7894ef08f..5035ebb8496 100644 --- a/docs/dyn/analytics_v3.data.ga.html +++ b/docs/dyn/analytics_v3.data.ga.html @@ -75,11 +75,11 @@

Google Analytics API . data . ga

Instance Methods

- get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=None)

+ get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, include_empty_rows=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=None)

Returns Analytics data for a view (profile).

Method Details

- get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=None) + get(ids, start_date, end_date, metrics, max_results=None, filters=None, dimensions=None, include_empty_rows=None, sort=None, samplingLevel=None, segment=None, start_index=None, output=None)
Returns Analytics data for a view (profile).
 
 Args:
@@ -90,6 +90,7 @@ 

Method Details

max_results: integer, The maximum number of entries to include in this feed. filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data. dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. + include_empty_rows: boolean, The response will include empty rows if this parameter is set to true, the default is true sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. samplingLevel: string, The desired sampling level. Allowed values diff --git a/docs/dyn/analytics_v3.management.profiles.html b/docs/dyn/analytics_v3.management.profiles.html index bfa0370105d..daf686f27e7 100644 --- a/docs/dyn/analytics_v3.management.profiles.html +++ b/docs/dyn/analytics_v3.management.profiles.html @@ -124,6 +124,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -173,6 +174,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -215,6 +217,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -271,6 +274,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -328,6 +332,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -370,6 +375,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -420,6 +426,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -462,6 +469,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. diff --git a/docs/dyn/analytics_v3.management.unsampledReports.html b/docs/dyn/analytics_v3.management.unsampledReports.html index e95de980beb..186103f255b 100644 --- a/docs/dyn/analytics_v3.management.unsampledReports.html +++ b/docs/dyn/analytics_v3.management.unsampledReports.html @@ -74,6 +74,9 @@

Google Analytics API . management . unsampledReports

Instance Methods

+

+ delete(accountId, webPropertyId, profileId, unsampledReportId)

+

Deletes an unsampled report.

get(accountId, webPropertyId, profileId, unsampledReportId)

Returns a single unsampled report.

@@ -84,6 +87,18 @@

Instance Methods

list(accountId, webPropertyId, profileId, max_results=None, start_index=None)

Lists unsampled reports to which the user has access.

Method Details

+
+ delete(accountId, webPropertyId, profileId, unsampledReportId) +
Deletes an unsampled report.
+
+Args:
+  accountId: string, Account ID to delete the unsampled report for. (required)
+  webPropertyId: string, Web property ID to delete the unsampled reports for. (required)
+  profileId: string, View (Profile) ID to delete the unsampled report for. (required)
+  unsampledReportId: string, ID of the unsampled report to be deleted. (required)
+
+
+
get(accountId, webPropertyId, profileId, unsampledReportId)
Returns a single unsampled report.
diff --git a/docs/dyn/analytics_v3.provisioning.html b/docs/dyn/analytics_v3.provisioning.html
index 3f5afb883e1..e16a6007c46 100644
--- a/docs/dyn/analytics_v3.provisioning.html
+++ b/docs/dyn/analytics_v3.provisioning.html
@@ -95,6 +95,7 @@ 

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. @@ -187,6 +188,7 @@

Method Details

"timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. "id": "A String", # View (Profile) ID. "accountId": "A String", # Account ID to which this view (profile) belongs. + "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile). "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports. "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile). "type": "A String", # View (Profile) type. Supported types: WEB or APP. diff --git a/docs/dyn/androidenterprise_v1.collectionviewers.html b/docs/dyn/androidenterprise_v1.collectionviewers.html index 97fa5b27a41..b5bc9619df9 100644 --- a/docs/dyn/androidenterprise_v1.collectionviewers.html +++ b/docs/dyn/androidenterprise_v1.collectionviewers.html @@ -115,11 +115,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }
@@ -140,11 +140,11 @@

Method Details

"user": [ # A user of an enterprise. { # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }, ], @@ -164,11 +164,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. } @@ -178,11 +178,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }
@@ -200,11 +200,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. } @@ -214,11 +214,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }
diff --git a/docs/dyn/androidenterprise_v1.devices.html b/docs/dyn/androidenterprise_v1.devices.html index 0ce85f6dea4..5fc4fd554db 100644 --- a/docs/dyn/androidenterprise_v1.devices.html +++ b/docs/dyn/androidenterprise_v1.devices.html @@ -99,11 +99,11 @@

Method Details

Returns: An object of the form: - { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user. + { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. # # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed. "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". - "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device. + "managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0". }
@@ -139,11 +139,11 @@

Method Details

{ # The device resources for the user. "device": [ # A managed device. - { # A device resource represents a mobile device managed by the MDM and belonging to a specific enterprise user. + { # A device resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. # # This collection cannot be modified via the API; it is automatically populated as devices are set up to be managed. "kind": "androidenterprise#device", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#device". - "managementType": "A String", # The mechanism by which this device is managed by the MDM. "managedDevice" means that the MDM's app is a device owner. "managedProfile" means that the MDM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the MDM's app is managing the Android for Work container app on the device. + "managementType": "A String", # The mechanism by which this device is managed by the EMM. "managedDevice" means that the EMM's app is a device owner. "managedProfile" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). "containerApp" means that the EMM's app is managing the Android for Work container app on the device. "androidId": "A String", # The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. "123456789abcdef0". }, ], diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index 6f25523d276..8e7baa80ed2 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -76,32 +76,38 @@

Google Play EMM API . delete(enterpriseId)

-

Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.

+

Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.

enroll(token, body)

-

Enrolls an enterprise with the calling MDM.

+

Enrolls an enterprise with the calling EMM.

get(enterpriseId)

Retrieves the name and domain of an enterprise.

+

+ getStoreLayout(enterpriseId)

+

Returns the store layout resource.

insert(token, body)

-

Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.

+

Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.

list(domain)

Looks up an enterprise by domain name.

sendTestPushNotification(enterpriseId)

-

Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.

+

Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

setAccount(enterpriseId, body)

Set the account that will be used to authenticate to the API as the enterprise.

+

+ setStoreLayout(enterpriseId, body)

+

Sets the store layout resource.

unenroll(enterpriseId)

-

Unenrolls an enterprise from the calling MDM.

+

Unenrolls an enterprise from the calling EMM.

Method Details

delete(enterpriseId) -
Deletes the binding between the MDM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.
+  
Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -110,20 +116,20 @@ 

Method Details

enroll(token, body) -
Enrolls an enterprise with the calling MDM.
+  
Enrolls an enterprise with the calling EMM.
 
 Args:
-  token: string, The token provided by the enterprise to register the MDM. (required)
+  token: string, The token provided by the enterprise to register the EMM. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # An enterprise resource represents a binding between an organisation and their MDM.
+{ # An enterprise resource represents a binding between an organisation and their EMM.
       # 
-      # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+      # To 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.
       # 
-      # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+      # After 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).
       # 
-      # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+      # The 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.
       # 
       # The 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.
     "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
@@ -136,13 +142,13 @@ 

Method Details

Returns: An object of the form: - { # An enterprise resource represents a binding between an organisation and their MDM. + { # An enterprise resource represents a binding between an organisation and their EMM. # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise. + # To 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. # - # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). + # After 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). # - # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. + # The 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. # # The 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. "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". @@ -162,13 +168,13 @@

Method Details

Returns: An object of the form: - { # An enterprise resource represents a binding between an organisation and their MDM. + { # An enterprise resource represents a binding between an organisation and their EMM. # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise. + # To 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. # - # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). + # After 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). # - # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. + # The 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. # # The 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. "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". @@ -178,22 +184,42 @@

Method Details

}
+
+ getStoreLayout(enterpriseId) +
Returns the store layout resource.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+  An object of the form:
+
+    { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
+    "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
+        #
+        # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
+        #
+        # If there exists at least one page, this field must be set to the ID of a valid page.
+    "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+  }
+
+
insert(token, body) -
Establishes the binding between the MDM and an enterprise. This is now deprecated; use enroll instead.
+  
Establishes the binding between the EMM and an enterprise. This is now deprecated; use enroll instead.
 
 Args:
-  token: string, The token provided by the enterprise to register the MDM. (required)
+  token: string, The token provided by the enterprise to register the EMM. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # An enterprise resource represents a binding between an organisation and their MDM.
+{ # An enterprise resource represents a binding between an organisation and their EMM.
       # 
-      # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise.
+      # To 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.
       # 
-      # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token).
+      # After 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).
       # 
-      # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call.
+      # The 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.
       # 
       # The 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.
     "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise".
@@ -206,13 +232,13 @@ 

Method Details

Returns: An object of the form: - { # An enterprise resource represents a binding between an organisation and their MDM. + { # An enterprise resource represents a binding between an organisation and their EMM. # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise. + # To 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. # - # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). + # After 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). # - # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. + # The 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. # # The 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. "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". @@ -235,13 +261,13 @@

Method Details

{ # The matching enterprise resources. "kind": "androidenterprise#enterprisesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse". "enterprise": [ # An enterprise. - { # An enterprise resource represents a binding between an organisation and their MDM. + { # An enterprise resource represents a binding between an organisation and their EMM. # - # To create an enterprise, an admin of the enterprise must first go through a Play for Work sign-up flow. At the end of this the admin will be presented with a token (a short opaque alphanumeric string). They must then present this to the MDM, who then supplies it to the enroll method. Until this is done the MDM will not have any access to the enterprise. + # To 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. # - # After calling enroll the MDM should call setAccount to specify the service account that will be allowed to act on behalf of the enterprise, which will be required for access to the enterprise's data through this API. Only one call of setAccount is allowed for a given enterprise; the only way to change the account later is to unenroll the enterprise and enroll it again (obtaining a new token). + # After 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). # - # The MDM can unenroll an enterprise in order to sever the binding between them. Re-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the MDM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) Enterprises.insert call must be unenrolled with Enterprises.delete and can then be re-enrolled using the Enterprises.enroll call. + # The 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. # # The 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. "kind": "androidenterprise#enterprise", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprise". @@ -255,7 +281,7 @@

Method Details

sendTestPushNotification(enterpriseId) -
Sends a test push notification to validate the MDM integration with the Google Cloud Pubsub service for this enterprise.
+  
Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -264,7 +290,7 @@ 

Method Details

An object of the form: { - "topicName": "A String", # The name of the Cloud Pubsub topic to which notifications for this enterprise's enrolled account will be sent. + "topicName": "A String", # The name of the Cloud Pub/Sub topic to which notifications for this enterprise's enrolled account will be sent. "messageId": "A String", # The message ID of the test push notification that was sent. }
@@ -293,9 +319,41 @@

Method Details

}
+
+ setStoreLayout(enterpriseId, body) +
Sets the store layout resource.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
+  "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
+      # 
+      # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
+      # 
+      # If there exists at least one page, this field must be set to the ID of a valid page.
+  "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+}
+
+
+Returns:
+  An object of the form:
+
+    { # General setting for the Google Play for Work store layout, currently only specifying the page to display the first time the store is opened.
+    "homepageId": "A String", # The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.
+        #
+        # If there is no homepage set, an empty store is shown. The homepage can be unset (by not specifying it) to empty the store.
+        #
+        # If there exists at least one page, this field must be set to the ID of a valid page.
+    "kind": "androidenterprise#storeLayout", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayout".
+  }
+
+
unenroll(enterpriseId) -
Unenrolls an enterprise from the calling MDM.
+  
Unenrolls an enterprise from the calling EMM.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.entitlements.html b/docs/dyn/androidenterprise_v1.entitlements.html
index 598bee5e0d5..3db74dcd62d 100644
--- a/docs/dyn/androidenterprise_v1.entitlements.html
+++ b/docs/dyn/androidenterprise_v1.entitlements.html
@@ -115,7 +115,7 @@ 

Method Details

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # @@ -144,7 +144,7 @@

Method Details

"entitlement": [ # An entitlement of a user to a product (e.g. an app). For example, a free app that they have installed, or a paid app that they have been allocated a license to. { # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # @@ -172,7 +172,7 @@

Method Details

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # @@ -191,7 +191,7 @@

Method Details

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # @@ -217,7 +217,7 @@

Method Details

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # @@ -236,7 +236,7 @@

Method Details

{ # The existence of an entitlement resource means that a user has the right to use a particular app on any of their devices. This might be because the app is free or because they have been allocated a license to the app from a group license purchased by the enterprise. # - # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the MDM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. + # It should always be true that a user has an app installed on one of their devices only if they have an entitlement to it. So if an entitlement is deleted, the app will be uninstalled from all devices. Similarly if the user installs an app (and is permitted to do so), or the EMM triggers an install of the app, an entitlement to that app is automatically created. If this is impossible - e.g. the enterprise has not purchased sufficient licenses - then installation fails. # # Note that entitlements are always user specific, not device specific; a user may have an entitlement even though they have not installed the app anywhere. Once they have an entitlement they can install the app on multiple devices. # diff --git a/docs/dyn/androidenterprise_v1.grouplicenseusers.html b/docs/dyn/androidenterprise_v1.grouplicenseusers.html index 70e3997a0d4..d803c9f97cb 100644 --- a/docs/dyn/androidenterprise_v1.grouplicenseusers.html +++ b/docs/dyn/androidenterprise_v1.grouplicenseusers.html @@ -94,11 +94,11 @@

Method Details

"user": [ # A user of an enterprise. { # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }, ], diff --git a/docs/dyn/androidenterprise_v1.html b/docs/dyn/androidenterprise_v1.html index 699f8118f40..2d533ca255c 100644 --- a/docs/dyn/androidenterprise_v1.html +++ b/docs/dyn/androidenterprise_v1.html @@ -124,6 +124,16 @@

Instance Methods

Returns the products Resource.

+

+ storelayoutclusters() +

+

Returns the storelayoutclusters Resource.

+ +

+ storelayoutpages() +

+

Returns the storelayoutpages Resource.

+

users()

diff --git a/docs/dyn/androidenterprise_v1.permissions.html b/docs/dyn/androidenterprise_v1.permissions.html index 386e7b4a18c..d59f04e0cdf 100644 --- a/docs/dyn/androidenterprise_v1.permissions.html +++ b/docs/dyn/androidenterprise_v1.permissions.html @@ -91,7 +91,7 @@

Method Details

{ # A permission represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. # - # The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise. + # The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the EMM user interface when obtaining consent from the enterprise. "permissionId": "A String", # An opaque string uniquely identifying the permission. "kind": "androidenterprise#permission", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#permission". "description": "A String", # A longer description of the permissions giving more details of what it affects. diff --git a/docs/dyn/androidenterprise_v1.products.html b/docs/dyn/androidenterprise_v1.products.html index ad40c7f0270..6b50b19c65e 100644 --- a/docs/dyn/androidenterprise_v1.products.html +++ b/docs/dyn/androidenterprise_v1.products.html @@ -91,7 +91,7 @@

Instance Methods

Retrieves the Android app permissions required by this app.

updatePermissions(enterpriseId, productId, body)

-

Updates the set of Android app permissions for this app that have been accepted by the enterprise.

+

This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.

Method Details

approve(enterpriseId, productId, body) @@ -146,7 +146,7 @@

Method Details

{ # A product represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) # - # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an MDM user interface. + # The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface. "kind": "androidenterprise#product", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product". "distributionChannel": "A String", # How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play Store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. "title": "A String", # The name of the product. @@ -157,6 +157,7 @@

Method Details

"versionString": "A String", # The string used in the Play Store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4"). }, ], + "productPricing": "A String", # Whether this product is free, free with in-app purchases, or paid. "iconUrl": "A String", # A link to an image that can be used as an icon for the product. "authorName": "A String", # The name of the author of the product (e.g. the app developer). "requiresContainerApp": True or False, # Whether this app can only be installed on devices using the Android for Work container app. @@ -232,7 +233,9 @@

Method Details

updatePermissions(enterpriseId, productId, body) -
Updates the set of Android app permissions for this app that have been accepted by the enterprise.
+  
This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the  generateApprovalUrl and  approve methods of the Products resource. For more information, see the  Play EMM API usage requirements.
+
+The updatePermissions method (deprecated) updates the set of Android app permissions for this app that have been accepted by the enterprise.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
diff --git a/docs/dyn/androidenterprise_v1.storelayoutclusters.html b/docs/dyn/androidenterprise_v1.storelayoutclusters.html
new file mode 100644
index 00000000000..b175361a85f
--- /dev/null
+++ b/docs/dyn/androidenterprise_v1.storelayoutclusters.html
@@ -0,0 +1,320 @@
+
+
+
+

Google Play EMM API . storelayoutclusters

+

Instance Methods

+

+ delete(enterpriseId, pageId, clusterId)

+

Deletes a cluster.

+

+ get(enterpriseId, pageId, clusterId)

+

Retrieves details of a cluster.

+

+ insert(enterpriseId, pageId, body)

+

Inserts a new cluster in a page.

+

+ list(enterpriseId, pageId)

+

Retrieves the details of all clusters on the specified page.

+

+ patch(enterpriseId, pageId, clusterId, body)

+

Updates a cluster. This method supports patch semantics.

+

+ update(enterpriseId, pageId, clusterId, body)

+

Updates a cluster.

+

Method Details

+
+ delete(enterpriseId, pageId, clusterId) +
Deletes a cluster.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  clusterId: string, The ID of the cluster. (required)
+
+
+ +
+ get(enterpriseId, pageId, clusterId) +
Retrieves details of a cluster.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  clusterId: string, The ID of the cluster. (required)
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+          #
+          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ insert(enterpriseId, pageId, body) +
Inserts a new cluster in a page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+        # 
+        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+          #
+          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ list(enterpriseId, pageId) +
Retrieves the details of all clusters on the specified page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+
+Returns:
+  An object of the form:
+
+    { # The store page resources for the enterprise.
+    "cluster": [ # A store cluster of an enterprise.
+      { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+          "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+          "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+              #
+              # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+          "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+            "A String",
+          ],
+          "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+          "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+            { # A localized string with its locale.
+              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+              "text": "A String", # The text localized in the associated locale.
+            },
+          ],
+        },
+    ],
+    "kind": "androidenterprise#storeLayoutClustersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutClustersListResponse".
+  }
+
+ +
+ patch(enterpriseId, pageId, clusterId, body) +
Updates a cluster. This method supports patch semantics.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  clusterId: string, The ID of the cluster. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+        # 
+        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+          #
+          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ update(enterpriseId, pageId, clusterId, body) +
Updates a cluster.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  clusterId: string, The ID of the cluster. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+    "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+    "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+        # 
+        # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+    "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.
+      "kind": "androidenterprise#storeCluster", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeCluster".
+      "orderInPage": "A String", # String (US-ASCII only) used to determine order of this cluster within the parent page's elements. Page elements are sorted in lexicographic order of this field. Duplicated values are allowed, but ordering between elements with duplicate order is undefined.
+          #
+          # The value of this field is never visible to a user, it is used solely for the purpose of defining an ordering. Maximum length is 20 characters.
+      "productId": [ # List of products in the order they are displayed in the cluster. There should not be duplicates within a cluster.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this cluster. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.storelayoutpages.html b/docs/dyn/androidenterprise_v1.storelayoutpages.html new file mode 100644 index 00000000000..8a3db4ea61f --- /dev/null +++ b/docs/dyn/androidenterprise_v1.storelayoutpages.html @@ -0,0 +1,306 @@ + + + +

Google Play EMM API . storelayoutpages

+

Instance Methods

+

+ delete(enterpriseId, pageId)

+

Deletes a store page.

+

+ get(enterpriseId, pageId)

+

Retrieves details of a store page.

+

+ insert(enterpriseId, body)

+

Inserts a new store page.

+

+ list(enterpriseId)

+

Retrieves the details of all pages in the store.

+

+ patch(enterpriseId, pageId, body)

+

Updates the content of a store page. This method supports patch semantics.

+

+ update(enterpriseId, pageId, body)

+

Updates the content of a store page.

+

Method Details

+
+ delete(enterpriseId, pageId) +
Deletes a store page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+
+
+ +
+ get(enterpriseId, pageId) +
Retrieves details of a store page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+          #
+          # No attempt is made to verify that all pages are reachable from the homepage.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ insert(enterpriseId, body) +
Inserts a new store page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+        # 
+        # No attempt is made to verify that all pages are reachable from the homepage.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+          #
+          # No attempt is made to verify that all pages are reachable from the homepage.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ list(enterpriseId) +
Retrieves the details of all pages in the store.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+
+Returns:
+  An object of the form:
+
+    { # The store page resources for the enterprise.
+    "kind": "androidenterprise#storeLayoutPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storeLayoutPagesListResponse".
+    "page": [ # A store page of an enterprise.
+      { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+          "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+          "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+              #
+              # No attempt is made to verify that all pages are reachable from the homepage.
+            "A String",
+          ],
+          "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+          "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+            { # A localized string with its locale.
+              "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+              "text": "A String", # The text localized in the associated locale.
+            },
+          ],
+        },
+    ],
+  }
+
+ +
+ patch(enterpriseId, pageId, body) +
Updates the content of a store page. This method supports patch semantics.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+        # 
+        # No attempt is made to verify that all pages are reachable from the homepage.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+          #
+          # No attempt is made to verify that all pages are reachable from the homepage.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ +
+ update(enterpriseId, pageId, body) +
Updates the content of a store page.
+
+Args:
+  enterpriseId: string, The ID of the enterprise. (required)
+  pageId: string, The ID of the page. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+    "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+    "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+        # 
+        # No attempt is made to verify that all pages are reachable from the homepage.
+      "A String",
+    ],
+    "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+    "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+      { # A localized string with its locale.
+        "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+        "text": "A String", # The text localized in the associated locale.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Definition of a Google Play for Work store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection.
+      "kind": "androidenterprise#storePage", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#storePage".
+      "link": [ # Ordered list of pages a user should be able to reach from this page. The pages must exist, must not be this page, and once a link is created the page linked to cannot be deleted until all links to it are removed. It is recommended that the basic pages are created first, before adding the links between pages.
+          #
+          # No attempt is made to verify that all pages are reachable from the homepage.
+        "A String",
+      ],
+      "id": "A String", # Unique ID of this page. Assigned by the server. Immutable once assigned.
+      "name": [ # Ordered list of localized strings giving the name of this page. The text displayed is the one that best matches the user locale, or the first entry if there is no good match. There needs to be at least one entry.
+        { # A localized string with its locale.
+          "locale": "A String", # The BCP47 tag for a locale. (e.g. "en-US", "de").
+          "text": "A String", # The text localized in the associated locale.
+        },
+      ],
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidenterprise_v1.users.html b/docs/dyn/androidenterprise_v1.users.html index 124750a12b3..ed911d59cc2 100644 --- a/docs/dyn/androidenterprise_v1.users.html +++ b/docs/dyn/androidenterprise_v1.users.html @@ -85,7 +85,7 @@

Instance Methods

Retrieves the set of products a user is entitled to access.

list(enterpriseId, email)

-

Looks up a user by email address.

+

Looks up a user by their primary email address.

revokeToken(enterpriseId, userId)

Revokes a previously generated token (activation code) for the user.

@@ -97,6 +97,8 @@

Method Details

generateToken(enterpriseId, userId)
Generates a token (activation code) to allow this user to configure their work account in the Android Setup Wizard. Revokes any previously generated token.
 
+This call only works with Google managed accounts.
+
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
   userId: string, The ID of the user. (required)
@@ -104,7 +106,7 @@ 

Method Details

Returns: An object of the form: - { # A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate MDM app can be automatically downloaded. + { # A UserToken is used by a user when setting up a managed device or profile with their work account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded. "kind": "androidenterprise#userToken", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#userToken". "userId": "A String", # The unique ID for the user. "token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0. @@ -124,11 +126,11 @@

Method Details

{ # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }
@@ -154,7 +156,7 @@

Method Details

list(enterpriseId, email) -
Looks up a user by email address.
+  
Looks up a user by their primary email address.
 
 Args:
   enterpriseId: string, The ID of the enterprise. (required)
@@ -168,11 +170,11 @@ 

Method Details

"user": [ # A user of an enterprise. { # A user resource represents an individual user within the enterprise's domain. # - # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing an MDM app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. + # Note that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise's domains). As part of installing the EMM's DPC app to manage a device the Google account must be provisioned to the device, and so the user resource must be created before that. This can be done using the Google Admin SDK Directory API. # # The ID for a user is an opaque string. It can be retrieved using the list method queried by the user's primary email address. "kind": "androidenterprise#user", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#user". - "primaryEmail": "A String", # The user's primary email, e.g. "jsmith@example.com". + "primaryEmail": "A String", # 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. "id": "A String", # The unique ID for the user. }, ], diff --git a/docs/dyn/androidpublisher_v2.edits.images.html b/docs/dyn/androidpublisher_v2.edits.images.html index 8afbb5f6bd4..5d4a27f7460 100644 --- a/docs/dyn/androidpublisher_v2.edits.images.html +++ b/docs/dyn/androidpublisher_v2.edits.images.html @@ -105,6 +105,7 @@

Method Details

tenInchScreenshots - tvBanner - tvScreenshots - + wearScreenshots - imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
@@ -127,6 +128,7 @@

Method Details

tenInchScreenshots - tvBanner - tvScreenshots - + wearScreenshots - Returns: An object of the form: @@ -160,6 +162,7 @@

Method Details

tenInchScreenshots - tvBanner - tvScreenshots - + wearScreenshots - Returns: An object of the form: @@ -193,6 +196,7 @@

Method Details

tenInchScreenshots - tvBanner - tvScreenshots - + wearScreenshots - media_body: string, The filename of the media request body, or an instance of a MediaUpload object. Returns: diff --git a/docs/dyn/androidpublisher_v2.inappproducts.html b/docs/dyn/androidpublisher_v2.inappproducts.html index 0cb97aa16fd..d2ffec04c33 100644 --- a/docs/dyn/androidpublisher_v2.inappproducts.html +++ b/docs/dyn/androidpublisher_v2.inappproducts.html @@ -112,13 +112,25 @@

Method Details

"inappproduct": { "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -150,13 +162,25 @@

Method Details

"inappproduct": { "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -199,13 +223,25 @@

Method Details

"inappproduct": { "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -236,13 +272,25 @@

Method Details

"inappproduct": { "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -299,13 +347,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -345,13 +405,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -386,13 +458,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -448,13 +532,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -497,13 +593,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -538,13 +646,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -585,13 +705,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, @@ -626,13 +758,25 @@

Method Details

{ "sku": "A String", # The stock-keeping-unit (SKU) of the product, unique within an app. "status": "A String", - "subscriptionPeriod": "A String", # The period of the subscription (if any), i.e. period at which payments must happen. Defined as ISO 8601 duration, i.e. "P1M" for 1 month period. + "subscriptionPeriod": "A String", # Subscription period, specified in ISO 8601 format. Acceptable values are "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). "season": { # Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - "start": { # Inclusive start date of the recurrence period. + "prorations": [ # Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. + { + "start": { # Defines the first day on which the price takes effect. + "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. + "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. + }, + "defaultPrice": { # Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. + "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. + "priceMicros": "A String", # The price in millionths of the currency base unit represented as a string. + }, + }, + ], + "end": { # Inclusive end date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, - "end": { # Inclusive end date of the recurrence period. + "start": { # Inclusive start date of the recurrence period. "day": 42, # Day of a month, value in [1, 31] range. Valid range depends on the specified month. "month": 42, # Month of a year. e.g. 1 = JAN, 2 = FEB etc. }, diff --git a/docs/dyn/appengine_v1beta5.apps.html b/docs/dyn/appengine_v1beta5.apps.html new file mode 100644 index 00000000000..61839b7a632 --- /dev/null +++ b/docs/dyn/appengine_v1beta5.apps.html @@ -0,0 +1,119 @@ + + + +

Google App Engine Admin API . apps

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ services() +

+

Returns the services Resource.

+ +

+ get(appsId, x__xgafv=None, ensureResourcesExist=None)

+

Gets information about an application.

+

Method Details

+
+ get(appsId, x__xgafv=None, ensureResourcesExist=None) +
Gets information about an application.
+
+Args:
+  appsId: string, Part of `name`. Name of the application to get. For example: "apps/myapp". (required)
+  x__xgafv: string, V1 error format.
+  ensureResourcesExist: boolean, Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the `GET` operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.
+
+Returns:
+  An object of the form:
+
+    { # An Application contains the top-level configuration of an App Engine application.
+    "name": "A String", # The full path to the application in the API. Example: "apps/myapp". @OutputOnly
+    "codeBucket": "A String", # A Google Cloud Storage bucket which can be used for storing files associated with an application. This bucket is associated with the application and can be used by the gcloud deployment commands. @OutputOnly
+    "defaultBucket": "A String", # A Google Cloud Storage bucket which can be used by the application to store content. @OutputOnly
+    "dispatchRules": [ # HTTP path dispatch rules for requests to the app that do not explicitly target a service or version. The rules are order-dependent.
+      { # Rules to match an HTTP request and dispatch that request to a service.
+        "path": "A String", # The pathname within the host. This must start with a '/'. A single '*' (glob) can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+        "domain": "A String", # The domain name to match on. Supports '*' (glob) wildcarding on the left-hand side of a '.'. If empty, all domains will be matched (the same as '*').
+        "service": "A String", # The resource id of a Service in this application that should service the matched request. The Service must already exist. Example: "default".
+      },
+    ],
+    "location": "A String", # 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".
+    "id": "A String", # The relative name/path of the application. Example: "myapp". @OutputOnly
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta5.apps.operations.html b/docs/dyn/appengine_v1beta5.apps.operations.html new file mode 100644 index 00000000000..d03b6dee38e --- /dev/null +++ b/docs/dyn/appengine_v1beta5.apps.operations.html @@ -0,0 +1,174 @@ + + + +

Google App Engine Admin API . apps . operations

+

Instance Methods

+

+ get(appsId, operationsId, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

+ list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(appsId, operationsId, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  appsId: string, Part of `name`. The name of the operation resource. (required)
+  operationsId: string, Part of `name`. See documentation of `appsId`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ list(appsId, pageSize=None, filter=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
+
+Args:
+  appsId: string, Part of `name`. The name of the operation collection. (required)
+  pageSize: integer, The standard list page size.
+  filter: string, The standard list filter.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+    "operations": [ # A list of operations that matches the specified filter in the request.
+      { # This resource represents a long-running operation that is the result of a network API call.
+        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+        "error": { # 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. # The error result of the operation in case of failure.
+          "message": "A String", # 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.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @ype with type URL.
+            },
+          ],
+        },
+        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+        "name": "A String", # 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`.
+        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      },
+    ],
+    "nextPageToken": "A String", # The standard List next-page token.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta5.apps.services.html b/docs/dyn/appengine_v1beta5.apps.services.html new file mode 100644 index 00000000000..705e8b7fc72 --- /dev/null +++ b/docs/dyn/appengine_v1beta5.apps.services.html @@ -0,0 +1,248 @@ + + + +

Google App Engine Admin API . apps . services

+

Instance Methods

+

+ versions() +

+

Returns the versions Resource.

+ +

+ delete(appsId, servicesId, x__xgafv=None)

+

Deletes a service and all enclosed versions.

+

+ get(appsId, servicesId, x__xgafv=None)

+

Gets the current configuration of the service.

+

+ list(appsId, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the services in the application.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(appsId, servicesId, body, migrateTraffic=None, mask=None, x__xgafv=None)

+

Updates the configuration of the specified service.

+

Method Details

+
+ delete(appsId, servicesId, x__xgafv=None) +
Deletes a service and all enclosed versions.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ get(appsId, servicesId, x__xgafv=None) +
Gets the current configuration of the service.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+      "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
+        "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
+        "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+          "a_key": 3.14,
+        },
+      },
+      "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
+      "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+    }
+
+ +
+ list(appsId, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the services in the application.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp". (required)
+  pageSize: integer, Maximum results to return per page.
+  pageToken: string, Continuation token for fetching the next page of results.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Response message for `Services.ListServices`.
+    "services": [ # The services belonging to the requested application.
+      { # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+          "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
+            "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
+            "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+              "a_key": 3.14,
+            },
+          },
+          "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
+          "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+        },
+    ],
+    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(appsId, servicesId, body, migrateTraffic=None, mask=None, x__xgafv=None) +
Updates the configuration of the specified service.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A service is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.
+    "split": { # Configuration for traffic splitting for versions within a single service. Traffic splitting allows traffic directed to the service to be assigned to one of several versions in a fractional way, enabling experiments and canarying new builds, for example. # A mapping that defines fractional HTTP traffic diversion to different versions within the service.
+      "shardBy": "A String", # Which mechanism should be used as a selector when choosing a version to send a request to. The traffic selection algorithm will be stable for either type until allocations are changed.
+      "allocations": { # Mapping from service version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version may only be specified once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated in this field may not be deleted until the service is deleted, or their traffic allocation is removed. Allocations must sum to 1. Supports precision up to two decimal places for IP-based splits and up to three decimal places for cookie-based splits.
+        "a_key": 3.14,
+      },
+    },
+    "name": "A String", # The full path to the Service resource in the API. Example: "apps/myapp/services/default" @OutputOnly
+    "id": "A String", # The relative name/path of the service within the application. Example: "default" @OutputOnly
+  }
+
+  migrateTraffic: boolean, Whether to use Traffic Migration to shift traffic gradually. Traffic can only be migrated from a single version to another single version.
+  mask: string, Standard field mask for the set of fields to be updated.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta5.apps.services.versions.html b/docs/dyn/appengine_v1beta5.apps.services.versions.html new file mode 100644 index 00000000000..9585a72a4eb --- /dev/null +++ b/docs/dyn/appengine_v1beta5.apps.services.versions.html @@ -0,0 +1,654 @@ + + + +

Google App Engine Admin API . apps . services . versions

+

Instance Methods

+

+ create(appsId, servicesId, body, x__xgafv=None)

+

Deploys new code and resource files to a version.

+

+ delete(appsId, servicesId, versionsId, x__xgafv=None)

+

Deletes an existing version.

+

+ get(appsId, servicesId, versionsId, x__xgafv=None, view=None)

+

Gets application deployment information.

+

+ list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)

+

Lists the versions of a service.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ create(appsId, servicesId, body, x__xgafv=None) +
Deploys new code and resource files to a version.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource to update. For example: "apps/myapp/services/default". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A Version is a specific set of source code and configuration files deployed to a service.
+    "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
+      "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
+      "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+    },
+    "betaSettings": { # Beta settings supplied to the application via metadata.
+      "a_key": "A String",
+    },
+    "vm": True or False, # Whether to deploy this app in a VM container.
+    "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
+    "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      { # A custom static error page to be served when an error occurs.
+        "errorCode": "A String", # The error condition this handler applies to.
+        "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+        "staticFile": "A String", # Static file content to be served for this error.
+      },
+    ],
+    "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
+    "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      "url": "A String", # URL to serve the endpoint at.
+      "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+      "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+      "login": "A String", # What level of login is required to access this resource. Default is "optional".
+      "script": "A String", # Specifies the path to the script from the application root directory.
+    },
+    "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
+    "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
+      "checkInterval": "A String", # The interval between health checks.
+      "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
+      "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
+      "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
+      "timeout": "A String", # The amount of time before the health check is considered failed.
+      "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
+    },
+    "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+    "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      { # A Python runtime third-party library required by the application.
+        "version": "A String", # The version of the library to select, or "latest".
+        "name": "A String", # The name of the library, e.g. "PIL" or "django".
+      },
+    ],
+    "deployer": "A String", # The email address of the user who created this version. @OutputOnly
+    "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+    "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
+    "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
+      "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+      "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
+        "targetReceivedBytesPerSec": 42, # Target bytes per second received.
+        "targetSentBytesPerSec": 42, # Target bytes per second sent.
+        "targetReceivedPacketsPerSec": 42, # Target packets per second received.
+        "targetSentPacketsPerSec": 42, # Target packets per second sent.
+      },
+      "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
+        "targetWriteOpsPerSec": 42, # Target ops per second written.
+        "targetReadBytesPerSec": 42, # Target bytes per second read.
+        "targetReadOpsPerSec": 42, # Target ops per second read.
+        "targetWriteBytesPerSec": 42, # Target bytes per second written.
+      },
+      "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+      "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
+      "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
+      "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+        "targetConcurrentRequests": 42, # Target number of concurrent requests.
+        "targetRequestCountPerSec": 42, # Target requests per second.
+      },
+      "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
+      "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
+      "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
+      "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+      "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+        "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
+        "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+      },
+    },
+    "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      "a_key": "A String",
+    },
+    "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
+      "diskGb": 3.14, # How much disk size, in GB, an app version needs.
+      "cpu": 3.14, # How many CPU cores an app version needs.
+      "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+    },
+    "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
+      "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+    },
+    "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
+      "A String",
+    ],
+    "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
+        "a_key": { # A single source file which is part of the application to be deployed.
+          "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
+          "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+          "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+        },
+      },
+      "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
+        { # A reference to a particular snapshot of the source tree used to build and deploy the application.
+          "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+          "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+        },
+      ],
+      "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
+        "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+      },
+    },
+    "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
+      "instanceTag": "A String", # A tag to apply to the VM instance during creation.
+      "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+        "A String",
+      ],
+      "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+    },
+    "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
+    "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
+    "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+        "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+        "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+        "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
+        "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
+          "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+        },
+        "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
+          "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+          "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+          "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
+          "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
+          "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
+          "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+          "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+            "a_key": "A String",
+          },
+        },
+        "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
+          "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+        },
+        "login": "A String", # What level of login is required to access this resource.
+        "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+      },
+    ],
+    "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
+    "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
+    "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ delete(appsId, servicesId, versionsId, x__xgafv=None) +
Deletes an existing version.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ get(appsId, servicesId, versionsId, x__xgafv=None, view=None) +
Gets application deployment information.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default/versions/v1". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  versionsId: string, Part of `name`. See documentation of `appsId`. (required)
+  x__xgafv: string, V1 error format.
+  view: string, Controls the set of fields returned in the `Get` response.
+
+Returns:
+  An object of the form:
+
+    { # A Version is a specific set of source code and configuration files deployed to a service.
+      "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
+        "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
+        "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+      },
+      "betaSettings": { # Beta settings supplied to the application via metadata.
+        "a_key": "A String",
+      },
+      "vm": True or False, # Whether to deploy this app in a VM container.
+      "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
+      "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        { # A custom static error page to be served when an error occurs.
+          "errorCode": "A String", # The error condition this handler applies to.
+          "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+          "staticFile": "A String", # Static file content to be served for this error.
+        },
+      ],
+      "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
+      "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        "url": "A String", # URL to serve the endpoint at.
+        "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+        "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+        "login": "A String", # What level of login is required to access this resource. Default is "optional".
+        "script": "A String", # Specifies the path to the script from the application root directory.
+      },
+      "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
+      "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
+        "checkInterval": "A String", # The interval between health checks.
+        "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
+        "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
+        "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
+        "timeout": "A String", # The amount of time before the health check is considered failed.
+        "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
+      },
+      "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+      "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        { # A Python runtime third-party library required by the application.
+          "version": "A String", # The version of the library to select, or "latest".
+          "name": "A String", # The name of the library, e.g. "PIL" or "django".
+        },
+      ],
+      "deployer": "A String", # The email address of the user who created this version. @OutputOnly
+      "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+      "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
+      "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
+        "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+        "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
+          "targetReceivedBytesPerSec": 42, # Target bytes per second received.
+          "targetSentBytesPerSec": 42, # Target bytes per second sent.
+          "targetReceivedPacketsPerSec": 42, # Target packets per second received.
+          "targetSentPacketsPerSec": 42, # Target packets per second sent.
+        },
+        "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
+          "targetWriteOpsPerSec": 42, # Target ops per second written.
+          "targetReadBytesPerSec": 42, # Target bytes per second read.
+          "targetReadOpsPerSec": 42, # Target ops per second read.
+          "targetWriteBytesPerSec": 42, # Target bytes per second written.
+        },
+        "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+        "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
+        "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
+        "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+          "targetConcurrentRequests": 42, # Target number of concurrent requests.
+          "targetRequestCountPerSec": 42, # Target requests per second.
+        },
+        "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
+        "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
+        "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
+        "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+        "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+          "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
+          "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+        },
+      },
+      "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        "a_key": "A String",
+      },
+      "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
+        "diskGb": 3.14, # How much disk size, in GB, an app version needs.
+        "cpu": 3.14, # How many CPU cores an app version needs.
+        "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+      },
+      "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
+        "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+      },
+      "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
+        "A String",
+      ],
+      "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
+          "a_key": { # A single source file which is part of the application to be deployed.
+            "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
+            "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+            "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+          },
+        },
+        "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
+          { # A reference to a particular snapshot of the source tree used to build and deploy the application.
+            "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+            "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+          },
+        ],
+        "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
+          "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+        },
+      },
+      "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
+        "instanceTag": "A String", # A tag to apply to the VM instance during creation.
+        "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+          "A String",
+        ],
+        "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+      },
+      "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
+      "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
+      "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+        { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+          "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+          "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+          "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
+          "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
+            "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+          },
+          "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
+            "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+            "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+            "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
+            "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
+            "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
+            "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+            "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+              "a_key": "A String",
+            },
+          },
+          "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
+            "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+          },
+          "login": "A String", # What level of login is required to access this resource.
+          "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+        },
+      ],
+      "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
+      "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
+      "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+    }
+
+ +
+ list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None) +
Lists the versions of a service.
+
+Args:
+  appsId: string, Part of `name`. Name of the resource requested. For example: "apps/myapp/services/default". (required)
+  servicesId: string, Part of `name`. See documentation of `appsId`. (required)
+  pageSize: integer, Maximum results to return per page.
+  x__xgafv: string, V1 error format.
+  pageToken: string, Continuation token for fetching the next page of results.
+  view: string, Controls the set of fields returned in the `List` response.
+
+Returns:
+  An object of the form:
+
+    { # Response message for `Versions.ListVersions`.
+    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+    "versions": [ # The versions belonging to the requested application service.
+      { # A Version is a specific set of source code and configuration files deployed to a service.
+          "basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
+            "idleTimeout": "A String", # The instance will be shut down this amount of time after receiving its last request.
+            "maxInstances": 42, # The maximum number of instances for App Engine to create for this version.
+          },
+          "betaSettings": { # Beta settings supplied to the application via metadata.
+            "a_key": "A String",
+          },
+          "vm": True or False, # Whether to deploy this app in a VM container.
+          "instanceClass": "A String", # The instance class to use to run this app. Valid values for AutomaticScaling are `[F1, F2, F4, F4_1G]`. Valid values for ManualScaling and BasicScaling are `[B1, B2, B4, B8, B4_1G]`. Default: "F1" for AutomaticScaling, "B1" for ManualScaling and BasicScaling
+          "errorHandlers": [ # Custom static error pages instead of these generic error pages, (limit 10 KB/page) Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            { # A custom static error page to be served when an error occurs.
+              "errorCode": "A String", # The error condition this handler applies to.
+              "mimeType": "A String", # MIME type of file. If unspecified, "text/html" is assumed.
+              "staticFile": "A String", # Static file content to be served for this error.
+            },
+          ],
+          "id": "A String", # The relative name/path of the Version within the service. Example: "v1". Version specifiers can contain lowercase letters, digits, and hyphens. It cannot begin with the prefix `ah-` and the names `default` and `latest` are reserved and cannot be used.
+          "apiConfig": { # API Serving configuration for Cloud Endpoints. # Serving configuration for Google Cloud Endpoints. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            "url": "A String", # URL to serve the endpoint at.
+            "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+            "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+            "login": "A String", # What level of login is required to access this resource. Default is "optional".
+            "script": "A String", # Specifies the path to the script from the application root directory.
+          },
+          "threadsafe": True or False, # If true, multiple requests can be dispatched to the app at once.
+          "healthCheck": { # Configure health checking for the VM instances. Unhealthy VM instances will be killed and replaced with new instances. # Configure health checking for the VM instances. Unhealthy VM instances will be stopped and replaced with new instances. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            "restartThreshold": 42, # The number of consecutive failed health checks before an instance is restarted.
+            "checkInterval": "A String", # The interval between health checks.
+            "unhealthyThreshold": 42, # The number of consecutive failed health checks before removing traffic.
+            "healthyThreshold": 42, # The number of consecutive successful health checks before receiving traffic.
+            "host": "A String", # The host header to send when performing an HTTP health check (e.g. myapp.appspot.com)
+            "timeout": "A String", # The amount of time before the health check is considered failed.
+            "disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
+          },
+          "defaultExpiration": "A String", # The length of time a static file served by a static file handler ought to be cached by web proxies and browsers, if the handler does not specify its own expiration. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+          "libraries": [ # Configuration for Python runtime third-party libraries required by the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            { # A Python runtime third-party library required by the application.
+              "version": "A String", # The version of the library to select, or "latest".
+              "name": "A String", # The name of the library, e.g. "PIL" or "django".
+            },
+          ],
+          "deployer": "A String", # The email address of the user who created this version. @OutputOnly
+          "env": "A String", # The App Engine execution environment to use for this version. Default: "1"
+          "diskUsageBytes": "A String", # Total size of version files hosted on App Engine disk in bytes. @OutputOnly
+          "automaticScaling": { # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics. # Automatic scaling is the scaling policy that App Engine has used since its inception. It is based on request rate, response latencies, and other application metrics.
+            "minPendingLatency": "A String", # The minimum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+            "networkUtilization": { # Target scaling by network usage (for VM runtimes only). # Target scaling by network usage.
+              "targetReceivedBytesPerSec": 42, # Target bytes per second received.
+              "targetSentBytesPerSec": 42, # Target bytes per second sent.
+              "targetReceivedPacketsPerSec": 42, # Target packets per second received.
+              "targetSentPacketsPerSec": 42, # Target packets per second sent.
+            },
+            "diskUtilization": { # Target scaling by disk usage (for VM runtimes only). # Target scaling by disk usage.
+              "targetWriteOpsPerSec": 42, # Target ops per second written.
+              "targetReadBytesPerSec": 42, # Target bytes per second read.
+              "targetReadOpsPerSec": 42, # Target ops per second read.
+              "targetWriteBytesPerSec": 42, # Target bytes per second written.
+            },
+            "maxPendingLatency": "A String", # The maximum amount of time that App Engine should allow a request to wait in the pending queue before starting a new instance to handle it.
+            "maxIdleInstances": 42, # The maximum number of idle instances that App Engine should maintain for this version.
+            "minIdleInstances": 42, # The minimum number of idle instances that App Engine should maintain for this version. Only applies to the default version of a service, since other versions are not expected to receive significant traffic.
+            "requestUtilization": { # Target scaling by request utilization (for VM runtimes only). # Target scaling by request utilization.
+              "targetConcurrentRequests": 42, # Target number of concurrent requests.
+              "targetRequestCountPerSec": 42, # Target requests per second.
+            },
+            "coolDownPeriod": "A String", # The amount of time that the [Autoscaler](https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Applies only to the VM runtime.
+            "maxTotalInstances": 42, # Max number of instances that App Engine should start to handle requests.
+            "maxConcurrentRequests": 42, # The number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Default value is chosen based on the runtime.
+            "minTotalInstances": 42, # Minimum number of instances that App Engine should maintain.
+            "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+              "targetUtilization": 3.14, # Target (0-1) CPU utilization ratio to maintain when scaling.
+              "aggregationWindowLength": "A String", # The period of time over which CPU utilization is calculated.
+            },
+          },
+          "envVariables": { # Environment variables made available to the application. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            "a_key": "A String",
+          },
+          "resources": { # Used to specify how many machine resources an app version needs. # Used to specify how many machine resources an app version needs (for VM runtimes only).
+            "diskGb": 3.14, # How much disk size, in GB, an app version needs.
+            "cpu": 3.14, # How many CPU cores an app version needs.
+            "memoryGb": 3.14, # How much memory, in GB, an app version needs.
+          },
+          "manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.
+            "instances": 42, # The number of instances to assign to the service at the start. This number can later be altered by using the [Modules API](https://cloud.google.com/appengine/docs/python/modules/functions) `set_num_instances()` function.
+          },
+          "inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
+            "A String",
+          ],
+          "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            "files": { # A manifest of files stored in Google Cloud Storage which should be included as part of this application. All files must be readable using the credentials supplied with this call.
+              "a_key": { # A single source file which is part of the application to be deployed.
+                "mimeType": "A String", # The MIME type of the file; if unspecified, the value from Google Cloud Storage will be used.
+                "sourceUrl": "A String", # The URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\/\'.
+                "sha1Sum": "A String", # The SHA1 (160 bits) hash of the file in hex.
+              },
+            },
+            "sourceReferences": [ # The origin of the source code for this deployment. There can be more than one source reference per Version if source code is distributed among multiple repositories.
+              { # A reference to a particular snapshot of the source tree used to build and deploy the application.
+                "revisionId": "A String", # The canonical (and persistent) identifier of the deployed revision, i.e. any kind of aliases including tags or branch names are not allowed. Example (git): "2198322f89e0bb2e25021667c2ed489d1fd34e6b"
+                "repository": "A String", # Optional. A URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
+              },
+            ],
+            "container": { # A Docker (container) image which should be used to start the application. # If supplied, a docker (container) image which should be used to start the application. Only applicable to the 'vm' runtime.
+              "image": "A String", # Reference to a hosted container image. Must be a URI to a resource in a Docker repository. Must be fully qualified, including tag or digest. e.g. gcr.io/my-project/image:tag or gcr.io/my-project/image@digest
+            },
+          },
+          "network": { # Used to specify extra network settings (for VM runtimes only). # Used to specify extra network settings (for VM runtimes only).
+            "instanceTag": "A String", # A tag to apply to the VM instance during creation.
+            "forwardedPorts": [ # A list of ports (or port pairs) to forward from the VM into the app container.
+              "A String",
+            ],
+            "name": "A String", # The Google Compute Engine network where the VMs will be created. If not specified, or empty, the network named "default" will be used. (The short name should be specified, not the resource path.)
+          },
+          "nobuildFilesRegex": "A String", # Go only. Files that match this pattern will not be built into the app. May only be set on create requests.
+          "name": "A String", # The full path to the Version resource in the API. Example: "apps/myapp/services/default/versions/v1". @OutputOnly
+          "handlers": [ # An ordered list of URL Matching patterns that should be applied to incoming requests. The first matching URL consumes the request, and subsequent handlers are not attempted. Only returned in `GET` requests if `view=FULL` is set. May only be set on create requests; once created, is immutable.
+            { # A URL pattern and description of how it should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the code, such as images, CSS or JavaScript.
+              "securityLevel": "A String", # Configures whether security (HTTPS) should be enforced for this URL.
+              "authFailAction": "A String", # For users not logged in, how to handle access to resources with required login. Defaults to "redirect".
+              "urlRegex": "A String", # A URL prefix. This value uses regular expression syntax (and so regexp special characters must be escaped), but it should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path. This is always required.
+              "script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the request that matches the URL pattern.
+                "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+              },
+              "staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
+                "mimeType": "A String", # If specified, all files served by this handler will be served using the specified MIME type. If not specified, the MIME type for a file will be derived from the file's filename extension.
+                "applicationReadable": True or False, # By default, files declared in static file handlers are uploaded as static data and are only served to end users, they cannot be read by an application. If this field is set to true, the files are also uploaded as code data so your application can read them. Both uploads are charged against your code and static data storage resource quotas.
+                "expiration": "A String", # The length of time a static file served by this handler ought to be cached by web proxies and browsers.
+                "requireMatchingFile": True or False, # If true, this UrlMap entry does not match the request unless the file referenced by the handler also exists. If no such file exists, processing will continue with the next UrlMap that matches the requested URL.
+                "uploadPathRegex": "A String", # A regular expression that matches the file paths for all files that will be referenced by this handler.
+                "path": "A String", # The path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
+                "httpHeaders": { # HTTP headers to use for all responses from these URLs.
+                  "a_key": "A String",
+                },
+              },
+              "apiEndpoint": { # Use Google Cloud Endpoints to handle requests. # Use API Endpoints to handle requests.
+                "scriptPath": "A String", # Specifies the path to the script from the application root directory.
+              },
+              "login": "A String", # What level of login is required to access this resource.
+              "redirectHttpResponseCode": "A String", # `30x` code to use when performing redirects for the `secure` field. A `302` is used by default.
+            },
+          ],
+          "creationTime": "A String", # Creation time of this version. This will be between the start and end times of the operation that creates this version. @OutputOnly
+          "servingStatus": "A String", # The current serving status of this version. Only `SERVING` versions will have instances created or billed for. If this field is unset when a version is created, `SERVING` status will be assumed. It is an error to explicitly set this field to `SERVING_STATUS_UNSPECIFIED`.
+          "runtime": "A String", # The desired runtime. Values can include python27, java7, go, etc.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/appengine_v1beta5.html b/docs/dyn/appengine_v1beta5.html new file mode 100644 index 00000000000..8d67e6db53a --- /dev/null +++ b/docs/dyn/appengine_v1beta5.html @@ -0,0 +1,103 @@ + + + +

Google App Engine Admin API

+

Instance Methods

+

+ apps() +

+

Returns the apps Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/appsactivity_v1.activities.html b/docs/dyn/appsactivity_v1.activities.html index e3f3f546e81..dda5212efeb 100644 --- a/docs/dyn/appsactivity_v1.activities.html +++ b/docs/dyn/appsactivity_v1.activities.html @@ -143,7 +143,7 @@

Method Details

"name": "A String", # The name of the user or group the permission applies to. "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. "user": { # A representation of a user. # The user's information if the type is USER. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. @@ -158,7 +158,7 @@

Method Details

"name": "A String", # The name of the user or group the permission applies to. "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. "user": { # A representation of a user. # The user's information if the type is USER. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. @@ -169,7 +169,7 @@

Method Details

}, ], "user": { # A representation of a user. # Represents the user responsible for the event. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. @@ -217,7 +217,7 @@

Method Details

"name": "A String", # The name of the user or group the permission applies to. "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. "user": { # A representation of a user. # The user's information if the type is USER. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. @@ -232,7 +232,7 @@

Method Details

"name": "A String", # The name of the user or group the permission applies to. "role": "A String", # Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file. "user": { # A representation of a user. # The user's information if the type is USER. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. @@ -243,7 +243,7 @@

Method Details

}, ], "user": { # A representation of a user. # Represents the user responsible for the event. - "photo": { # Photo information for a user. # The profile photo of the user. + "photo": { # Photo information for a user. # The profile photo of the user. Not present if the user has no profile photo. "url": "A String", # The URL of the photo. }, "name": "A String", # The displayable name of the user. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index b4aa84cc8ed..034182763e9 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -101,8 +101,8 @@

Method Details

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.
 
 Args:
-  projectId: string, Project ID of the job to cancel (required)
-  jobId: string, Job ID of the job to cancel (required)
+  projectId: string, [Required] Project ID of the job to cancel (required)
+  jobId: string, [Required] Job ID of the job to cancel (required)
 
 Returns:
   An object of the form:
@@ -138,10 +138,41 @@ 

Method Details

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. "query": { # [Output-only] Statistics for a query job. - "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. - "billingTier": 42, # [Output-only] Billing tier for the job. + "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query as a list of stages. + { + "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. + "recordsWritten": "A String", # Number of records written by the stage. + "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. + "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. + "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. + "steps": [ # List of operations within the stage in dependency order (approximately chronological). + { + "kind": "A String", # Machine-readable operation type. + "substeps": [ # Human-readable stage descriptions. + "A String", + ], + }, + ], + "recordsRead": "A String", # Number of records read into the stage. + "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. + "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. + "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. + "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. + "id": "A String", # Unique ID for stage within plan. + "name": "A String", # Human-readable name for stage. + }, + ], "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. + "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. + "billingTier": 42, # [Output-only] Billing tier for the job. + "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. @@ -159,7 +190,7 @@

Method Details

"configuration": { # [Required] Describes the job configuration. "load": { # [Pick one] Configures a load job. "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. - "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). + "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "sourceFormat": "A String", # [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. "destinationTable": { # [Required] The destination table to load the data into. "projectId": "A String", # [Required] The ID of the project containing this table. @@ -182,7 +213,7 @@

Method Details

"A String", ], "ignoreUnknownValues": True or False, # [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 - "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. + "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -196,26 +227,52 @@

Method Details

], }, }, - "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - "link": { # [Pick one] Configures a link job. + "extract": { # [Pick one] Configures an extract job. + "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. + "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. + "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' + "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. + "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. + "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. + "A String", + ], + "sourceTable": { # [Required] A reference to the table being exported. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + }, + "copy": { # [Pick one] Copies a table. "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. + "sourceTables": [ # [Pick one] Source tables to copy. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table of the link job. + "destinationTable": { # [Required] The destination table + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + "sourceTable": { # [Pick one] Source table to copy. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "datasetId": "A String", # [Required] The ID of the dataset containing this table. }, - "sourceUri": [ # [Required] URI of source table to link. - "A String", - ], }, + "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. "query": { # [Pick one] Configures a query job. "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false. + "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. "projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -227,9 +284,9 @@

Method Details

"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "query": "A String", # [Required] BigQuery SQL query to execute. "preserveNulls": True or False, # [Deprecated] This property is deprecated. - "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. "a_key": { - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -238,13 +295,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -266,42 +323,6 @@

Method Details

}, ], }, - "copy": { # [Pick one] Copies a table. - "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - "sourceTables": [ # [Pick one] Source tables to copy. - { - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - ], - "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - "sourceTable": { # [Pick one] Source table to copy. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, - "extract": { # [Pick one] Configures an extract job. - "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. - "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' - "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. - "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. - "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - "A String", - ], - "sourceTable": { # [Required] A reference to the table being exported. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, }, "id": "A String", # [Output-only] Opaque ID field of the job "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. @@ -315,8 +336,8 @@

Method Details

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.
 
 Args:
-  projectId: string, Project ID of the requested job (required)
-  jobId: string, Job ID of the requested job (required)
+  projectId: string, [Required] Project ID of the requested job (required)
+  jobId: string, [Required] Job ID of the requested job (required)
 
 Returns:
   An object of the form:
@@ -351,10 +372,41 @@ 

Method Details

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. "query": { # [Output-only] Statistics for a query job. - "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. - "billingTier": 42, # [Output-only] Billing tier for the job. + "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query as a list of stages. + { + "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. + "recordsWritten": "A String", # Number of records written by the stage. + "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. + "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. + "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. + "steps": [ # List of operations within the stage in dependency order (approximately chronological). + { + "kind": "A String", # Machine-readable operation type. + "substeps": [ # Human-readable stage descriptions. + "A String", + ], + }, + ], + "recordsRead": "A String", # Number of records read into the stage. + "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. + "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. + "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. + "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. + "id": "A String", # Unique ID for stage within plan. + "name": "A String", # Human-readable name for stage. + }, + ], "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. + "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. + "billingTier": 42, # [Output-only] Billing tier for the job. + "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. @@ -372,7 +424,7 @@

Method Details

"configuration": { # [Required] Describes the job configuration. "load": { # [Pick one] Configures a load job. "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. - "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). + "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "sourceFormat": "A String", # [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. "destinationTable": { # [Required] The destination table to load the data into. "projectId": "A String", # [Required] The ID of the project containing this table. @@ -395,7 +447,7 @@

Method Details

"A String", ], "ignoreUnknownValues": True or False, # [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 - "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. + "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -409,26 +461,52 @@

Method Details

], }, }, - "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - "link": { # [Pick one] Configures a link job. + "extract": { # [Pick one] Configures an extract job. + "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. + "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. + "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' + "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. + "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. + "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. + "A String", + ], + "sourceTable": { # [Required] A reference to the table being exported. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + }, + "copy": { # [Pick one] Copies a table. "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. + "sourceTables": [ # [Pick one] Source tables to copy. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table of the link job. + "destinationTable": { # [Required] The destination table + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + "sourceTable": { # [Pick one] Source table to copy. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "datasetId": "A String", # [Required] The ID of the dataset containing this table. }, - "sourceUri": [ # [Required] URI of source table to link. - "A String", - ], }, + "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. "query": { # [Pick one] Configures a query job. "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false. + "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. "projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -440,9 +518,9 @@

Method Details

"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "query": "A String", # [Required] BigQuery SQL query to execute. "preserveNulls": True or False, # [Deprecated] This property is deprecated. - "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. "a_key": { - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -451,13 +529,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -479,42 +557,6 @@

Method Details

}, ], }, - "copy": { # [Pick one] Copies a table. - "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - "sourceTables": [ # [Pick one] Source tables to copy. - { - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - ], - "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - "sourceTable": { # [Pick one] Source table to copy. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, - "extract": { # [Pick one] Configures an extract job. - "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. - "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' - "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. - "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. - "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - "A String", - ], - "sourceTable": { # [Required] A reference to the table being exported. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, }, "id": "A String", # [Output-only] Opaque ID field of the job "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. @@ -526,8 +568,8 @@

Method Details

Retrieves the results of a query job.
 
 Args:
-  projectId: string, Project ID of the query job (required)
-  jobId: string, Job ID of the query job (required)
+  projectId: string, [Required] Project ID of the query job (required)
+  jobId: string, [Required] Job ID of the query job (required)
   timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false
   pageToken: string, Page token, returned by a previous call, to request the next page of results
   maxResults: integer, Maximum number of results to read
@@ -620,10 +662,41 @@ 

Method Details

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. "query": { # [Output-only] Statistics for a query job. - "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. - "billingTier": 42, # [Output-only] Billing tier for the job. + "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query as a list of stages. + { + "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. + "recordsWritten": "A String", # Number of records written by the stage. + "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. + "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. + "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. + "steps": [ # List of operations within the stage in dependency order (approximately chronological). + { + "kind": "A String", # Machine-readable operation type. + "substeps": [ # Human-readable stage descriptions. + "A String", + ], + }, + ], + "recordsRead": "A String", # Number of records read into the stage. + "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. + "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. + "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. + "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. + "id": "A String", # Unique ID for stage within plan. + "name": "A String", # Human-readable name for stage. + }, + ], "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. + "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. + "billingTier": 42, # [Output-only] Billing tier for the job. + "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. @@ -641,7 +714,7 @@

Method Details

"configuration": { # [Required] Describes the job configuration. "load": { # [Pick one] Configures a load job. "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. - "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). + "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "sourceFormat": "A String", # [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. "destinationTable": { # [Required] The destination table to load the data into. "projectId": "A String", # [Required] The ID of the project containing this table. @@ -664,7 +737,7 @@

Method Details

"A String", ], "ignoreUnknownValues": True or False, # [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 - "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. + "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -678,26 +751,52 @@

Method Details

], }, }, - "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - "link": { # [Pick one] Configures a link job. + "extract": { # [Pick one] Configures an extract job. + "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. + "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. + "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' + "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. + "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. + "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. + "A String", + ], + "sourceTable": { # [Required] A reference to the table being exported. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + }, + "copy": { # [Pick one] Copies a table. "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. + "sourceTables": [ # [Pick one] Source tables to copy. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table of the link job. + "destinationTable": { # [Required] The destination table + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + "sourceTable": { # [Pick one] Source table to copy. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "datasetId": "A String", # [Required] The ID of the dataset containing this table. }, - "sourceUri": [ # [Required] URI of source table to link. - "A String", - ], }, + "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. "query": { # [Pick one] Configures a query job. "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false. + "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. "projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -709,9 +808,9 @@

Method Details

"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "query": "A String", # [Required] BigQuery SQL query to execute. "preserveNulls": True or False, # [Deprecated] This property is deprecated. - "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. "a_key": { - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -720,13 +819,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -748,42 +847,6 @@

Method Details

}, ], }, - "copy": { # [Pick one] Copies a table. - "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - "sourceTables": [ # [Pick one] Source tables to copy. - { - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - ], - "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - "sourceTable": { # [Pick one] Source table to copy. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, - "extract": { # [Pick one] Configures an extract job. - "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. - "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' - "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. - "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. - "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - "A String", - ], - "sourceTable": { # [Required] A reference to the table being exported. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, }, "id": "A String", # [Output-only] Opaque ID field of the job "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. @@ -824,10 +887,41 @@

Method Details

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. "query": { # [Output-only] Statistics for a query job. - "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. - "billingTier": 42, # [Output-only] Billing tier for the job. + "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query as a list of stages. + { + "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. + "recordsWritten": "A String", # Number of records written by the stage. + "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. + "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. + "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. + "steps": [ # List of operations within the stage in dependency order (approximately chronological). + { + "kind": "A String", # Machine-readable operation type. + "substeps": [ # Human-readable stage descriptions. + "A String", + ], + }, + ], + "recordsRead": "A String", # Number of records read into the stage. + "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. + "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. + "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. + "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. + "id": "A String", # Unique ID for stage within plan. + "name": "A String", # Human-readable name for stage. + }, + ], "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. + "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. + "billingTier": 42, # [Output-only] Billing tier for the job. + "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. @@ -845,7 +939,7 @@

Method Details

"configuration": { # [Required] Describes the job configuration. "load": { # [Pick one] Configures a load job. "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. - "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). + "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "sourceFormat": "A String", # [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. "destinationTable": { # [Required] The destination table to load the data into. "projectId": "A String", # [Required] The ID of the project containing this table. @@ -868,7 +962,7 @@

Method Details

"A String", ], "ignoreUnknownValues": True or False, # [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 - "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. + "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -882,26 +976,52 @@

Method Details

], }, }, - "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - "link": { # [Pick one] Configures a link job. + "extract": { # [Pick one] Configures an extract job. + "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. + "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. + "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' + "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. + "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. + "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. + "A String", + ], + "sourceTable": { # [Required] A reference to the table being exported. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + }, + "copy": { # [Pick one] Copies a table. "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. + "sourceTables": [ # [Pick one] Source tables to copy. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table of the link job. + "destinationTable": { # [Required] The destination table + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + "sourceTable": { # [Pick one] Source table to copy. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "datasetId": "A String", # [Required] The ID of the dataset containing this table. }, - "sourceUri": [ # [Required] URI of source table to link. - "A String", - ], }, + "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. "query": { # [Pick one] Configures a query job. "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false. + "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. "projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -913,9 +1033,9 @@

Method Details

"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "query": "A String", # [Required] BigQuery SQL query to execute. "preserveNulls": True or False, # [Deprecated] This property is deprecated. - "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. "a_key": { - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -924,13 +1044,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -952,42 +1072,6 @@

Method Details

}, ], }, - "copy": { # [Pick one] Copies a table. - "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - "sourceTables": [ # [Pick one] Source tables to copy. - { - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - ], - "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - "sourceTable": { # [Pick one] Source table to copy. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, - "extract": { # [Pick one] Configures an extract job. - "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. - "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' - "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. - "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. - "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - "A String", - ], - "sourceTable": { # [Required] A reference to the table being exported. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, }, "id": "A String", # [Output-only] Opaque ID field of the job "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. @@ -1051,10 +1135,41 @@

Method Details

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. "startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. "query": { # [Output-only] Statistics for a query job. - "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. - "billingTier": 42, # [Output-only] Billing tier for the job. + "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query as a list of stages. + { + "computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks. + "recordsWritten": "A String", # Number of records written by the stage. + "waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled. + "readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input. + "readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input. + "steps": [ # List of operations within the stage in dependency order (approximately chronological). + { + "kind": "A String", # Machine-readable operation type. + "substeps": [ # Human-readable stage descriptions. + "A String", + ], + }, + ], + "recordsRead": "A String", # Number of records read into the stage. + "computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks. + "writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. + "writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output. + "waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled. + "id": "A String", # Unique ID for stage within plan. + "name": "A String", # Human-readable name for stage. + }, + ], "totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job. "totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job. + "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. + "billingTier": 42, # [Output-only] Billing tier for the job. + "referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], }, "endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # [Output-only] Statistics for an extract job. @@ -1072,7 +1187,7 @@

Method Details

"configuration": { # [Full-projection-only] Specifies the job configuration. "load": { # [Pick one] Configures a load job. "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. - "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). + "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "sourceFormat": "A String", # [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. "destinationTable": { # [Required] The destination table to load the data into. "projectId": "A String", # [Required] The ID of the project containing this table. @@ -1095,7 +1210,7 @@

Method Details

"A String", ], "ignoreUnknownValues": True or False, # [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 - "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. + "schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -1109,26 +1224,52 @@

Method Details

], }, }, - "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. - "link": { # [Pick one] Configures a link job. + "extract": { # [Pick one] Configures an extract job. + "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. + "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. + "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' + "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. + "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. + "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. + "A String", + ], + "sourceTable": { # [Required] A reference to the table being exported. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + }, + "copy": { # [Pick one] Copies a table. "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. + "sourceTables": [ # [Pick one] Source tables to copy. + { + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + ], "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table of the link job. + "destinationTable": { # [Required] The destination table + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + }, + "sourceTable": { # [Pick one] Source table to copy. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. "datasetId": "A String", # [Required] The ID of the dataset containing this table. }, - "sourceUri": [ # [Required] URI of source table to link. - "A String", - ], }, + "dryRun": True or False, # [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. "query": { # [Pick one] Configures a query job. "flattenResults": true, # [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false. + "maximumBillingTier": 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default. "useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. "defaultDataset": { # [Optional] Specifies the default dataset to use for unqualified table names in the query. "projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. "projectId": "A String", # [Required] The ID of the project containing this table. "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1140,9 +1281,9 @@

Method Details

"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. "query": "A String", # [Required] BigQuery SQL query to execute. "preserveNulls": True or False, # [Deprecated] This property is deprecated. - "tableDefinitions": { # [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "tableDefinitions": { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. "a_key": { - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -1151,13 +1292,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -1179,42 +1320,6 @@

Method Details

}, ], }, - "copy": { # [Pick one] Copies a table. - "createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. - "sourceTables": [ # [Pick one] Source tables to copy. - { - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - ], - "writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion. - "destinationTable": { # [Required] The destination table - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - "sourceTable": { # [Pick one] Source table to copy. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, - "extract": { # [Pick one] Configures an extract job. - "destinationUri": "A String", # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. - "compression": "A String", # [Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE. - "fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ',' - "destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. - "printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. - "destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. - "A String", - ], - "sourceTable": { # [Required] A reference to the table being exported. - "projectId": "A String", # [Required] The ID of the project containing this table. - "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. - "datasetId": "A String", # [Required] The ID of the dataset containing this table. - }, - }, }, "id": "A String", # Unique opaque ID of the job. "errorResult": { # A result object that will be present only if the job has failed. @@ -1260,6 +1365,7 @@

Method Details

"projectId": "A String", # [Optional] The ID of the project containing this dataset. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. }, + "useLegacySql": True or False, # [Experimental] Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's updated SQL dialect with improved standards compliance. When using BigQuery's updated SQL, the values of allowLargeResults and flattenResults are ignored. Queries with useLegacySql set to false will be run as if allowLargeResults is true and flattenResults is false. "maxResults": 42, # [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies. "query": "A String", # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". "preserveNulls": True or False, # [Deprecated] This property is deprecated. diff --git a/docs/dyn/bigquery_v2.tabledata.html b/docs/dyn/bigquery_v2.tabledata.html index 5592d2c60a1..4074aa7d9ca 100644 --- a/docs/dyn/bigquery_v2.tabledata.html +++ b/docs/dyn/bigquery_v2.tabledata.html @@ -104,6 +104,7 @@

Method Details

}, ], "skipInvalidRows": True or False, # [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist. + "templateSuffix": "A String", # [Experimental] If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables. } diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index b4b1a319573..bda0cd3f23c 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -124,8 +124,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -134,13 +134,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -172,8 +172,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -207,8 +213,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -217,13 +223,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -255,8 +261,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -283,8 +295,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -293,13 +305,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -331,8 +343,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -415,8 +433,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -425,13 +443,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -463,8 +481,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -491,8 +515,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -501,13 +525,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -539,8 +563,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -575,8 +605,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -585,13 +615,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -623,8 +653,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. @@ -651,8 +687,8 @@

Method Details

"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch. "description": "A String", # [Optional] A user-friendly description of this table. "creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch. - "externalDataConfiguration": { # [Experimental] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. - "compression": "A String", # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. + "externalDataConfiguration": { # [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. + "compression": "A String", # [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. "csvOptions": { # Additional properties to set if sourceFormat is set to CSV. "fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). "encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. @@ -661,13 +697,13 @@

Method Details

"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. "allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. }, - "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". - "maxBadRecords": 42, # [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. - "ignoreUnknownValues": True or False, # [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 - "sourceUris": [ # [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. + "sourceFormat": "A String", # [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". + "maxBadRecords": 42, # [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. + "ignoreUnknownValues": True or False, # [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. + "sourceUris": [ # [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. "A String", ], - "schema": { # [Required] The schema for the data. + "schema": { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups. "fields": [ # Describes the fields in a table. { "fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD. @@ -699,8 +735,14 @@

Method Details

"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. "view": { # [Optional] The view definition. "query": "A String", # [Required] A query that BigQuery executes when the view is referenced. + "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query. + { + "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). + "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code. + }, + ], }, - "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. The default value is TABLE. + "type": "A String", # [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. "id": "A String", # [Output-only] An opaque ID uniquely identifying the table. "selfLink": "A String", # [Output-only] A URL that can be used to access this resource again. "schema": { # [Optional] Describes the schema of this table. diff --git a/docs/dyn/books_v1.bookshelves.volumes.html b/docs/dyn/books_v1.bookshelves.volumes.html index 992a9a3417a..7a61314c9e7 100644 --- a/docs/dyn/books_v1.bookshelves.volumes.html +++ b/docs/dyn/books_v1.bookshelves.volumes.html @@ -176,6 +176,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -232,15 +250,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -252,6 +272,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -270,14 +291,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.dictionary.html b/docs/dyn/books_v1.dictionary.html index 75f36753d64..47806af39d6 100644 --- a/docs/dyn/books_v1.dictionary.html +++ b/docs/dyn/books_v1.dictionary.html @@ -76,11 +76,11 @@

Books API . d

Instance Methods

listOfflineMetadata(cpksver)

-

Returns a list of offline dictionary meatadata available

+

Returns a list of offline dictionary metadata available

Method Details

listOfflineMetadata(cpksver) -
Returns a list of offline dictionary meatadata available
+  
Returns a list of offline dictionary metadata available
 
 Args:
   cpksver: string, The device/version ID from which to request the data. (required)
diff --git a/docs/dyn/books_v1.html b/docs/dyn/books_v1.html
index 64ab14b4883..7cbc50f3ff7 100644
--- a/docs/dyn/books_v1.html
+++ b/docs/dyn/books_v1.html
@@ -104,16 +104,31 @@ 

Instance Methods

Returns the mylibrary Resource.

+

+ notification() +

+

Returns the notification Resource.

+

onboarding()

Returns the onboarding Resource.

+

+ personalizedstream() +

+

Returns the personalizedstream Resource.

+

promooffer()

Returns the promooffer Resource.

+

+ series() +

+

Returns the series Resource.

+

volumes()

diff --git a/docs/dyn/books_v1.myconfig.html b/docs/dyn/books_v1.myconfig.html index 5470202ebe1..c03f8f047ec 100644 --- a/docs/dyn/books_v1.myconfig.html +++ b/docs/dyn/books_v1.myconfig.html @@ -84,7 +84,7 @@

Instance Methods

requestAccess(source, volumeId, nonce, cpksver, licenseTypes=None, locale=None)

Request concurrent and download access restrictions.

- syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None)

+ syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, includeNonComicsSeries=None, showPreorders=None, volumeIds=None)

Request downloaded content access for specified volumes on the My eBooks shelf.

updateUserSettings(body)

@@ -100,6 +100,11 @@

Method Details

An object of the form: { + "notification": { + "moreFromAuthors": { + "opted_state": "A String", + }, + }, "kind": "books#usersettings", # Resource type. "notesExport": { # User settings in sub-objects, each for different purposes. "isEnabled": True or False, @@ -194,7 +199,7 @@

Method Details

- syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, showPreorders=None, volumeIds=None) + syncVolumeLicenses(source, nonce, cpksver, features=None, locale=None, includeNonComicsSeries=None, showPreorders=None, volumeIds=None)
Request downloaded content access for specified volumes on the My eBooks shelf.
 
 Args:
@@ -205,6 +210,7 @@ 

Method Details

Allowed values RENTALS - Client supports rentals. locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US. + includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false. showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false. volumeIds: string, The volume(s) to request download restrictions for. (repeated) @@ -294,6 +300,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -350,15 +374,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -370,6 +396,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -388,14 +415,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], @@ -412,6 +442,11 @@

Method Details

The object takes the form of: { + "notification": { + "moreFromAuthors": { + "opted_state": "A String", + }, + }, "kind": "books#usersettings", # Resource type. "notesExport": { # User settings in sub-objects, each for different purposes. "isEnabled": True or False, @@ -424,6 +459,11 @@

Method Details

An object of the form: { + "notification": { + "moreFromAuthors": { + "opted_state": "A String", + }, + }, "kind": "books#usersettings", # Resource type. "notesExport": { # User settings in sub-objects, each for different purposes. "isEnabled": True or False, diff --git a/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html b/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html index dcd691d78da..8319124db91 100644 --- a/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html +++ b/docs/dyn/books_v1.mylibrary.bookshelves.volumes.html @@ -181,6 +181,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -237,15 +255,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -257,6 +277,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -275,14 +296,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.notification.html b/docs/dyn/books_v1.notification.html new file mode 100644 index 00000000000..6f7fc988e15 --- /dev/null +++ b/docs/dyn/books_v1.notification.html @@ -0,0 +1,106 @@ + + + +

Books API . notification

+

Instance Methods

+

+ get(notification_id, source=None, locale=None)

+

Returns notification details for a given notification id.

+

Method Details

+
+ get(notification_id, source=None, locale=None) +
Returns notification details for a given notification id.
+
+Args:
+  notification_id: string, String to identify the notification. (required)
+  source: string, String to identify the originator of this request.
+  locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.
+
+Returns:
+  An object of the form:
+
+    {
+    "body": "A String",
+    "kind": "books#notification", # Resource type.
+    "title": "A String",
+    "dont_show_notification": false,
+    "show_notification_settings_action": True or False,
+    "iconUrl": "A String",
+    "targetUrl": "A String",
+    "notification_type": "A String",
+    "pcampaign_id": "A String",
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/books_v1.onboarding.html b/docs/dyn/books_v1.onboarding.html index 6279bf93814..32daae4dea5 100644 --- a/docs/dyn/books_v1.onboarding.html +++ b/docs/dyn/books_v1.onboarding.html @@ -206,6 +206,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -262,15 +280,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -282,6 +302,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -300,14 +321,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.personalizedstream.html b/docs/dyn/books_v1.personalizedstream.html new file mode 100644 index 00000000000..7121856d9a3 --- /dev/null +++ b/docs/dyn/books_v1.personalizedstream.html @@ -0,0 +1,328 @@ + + + +

Books API . personalizedstream

+

Instance Methods

+

+ get(source=None, locale=None, maxAllowedMaturityRating=None)

+

Returns a stream of personalized book clusters

+

Method Details

+
+ get(source=None, locale=None, maxAllowedMaturityRating=None) +
Returns a stream of personalized book clusters
+
+Args:
+  source: string, String to identify the originator of this request.
+  locale: string, ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
+  maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
+    Allowed values
+      mature - Show books which are rated mature or lower.
+      not-mature - Show books which are rated not mature.
+
+Returns:
+  An object of the form:
+
+    {
+    "clusters": [
+      {
+        "totalVolumes": 42,
+        "subTitle": "A String",
+        "uid": "A String",
+        "title": "A String",
+        "banner_with_content_container": {
+          "moreButtonText": "A String",
+          "textColorArgb": "A String",
+          "imageUrl": "A String",
+          "fillColorArgb": "A String",
+          "maskColorArgb": "A String",
+          "moreButtonUrl": "A String",
+        },
+        "volumes": [
+          {
+            "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+            "accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
+              "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
+              "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+              "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+              "downloadAccess": { # Information about a volume's download license access restrictions.
+                "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+                "kind": "books#downloadAccessRestriction", # Resource type.
+                "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+                "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+                "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+                "signature": "A String", # Response signature.
+                "volumeId": "A String", # Identifies the volume for which this entry applies.
+                "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+                "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+                "restricted": True or False, # Whether this volume has any download access restrictions.
+                "reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
+                "message": "A String", # Error/warning message.
+              },
+              "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+              "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
+              "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
+              "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+              "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
+              "pdf": { # Information about pdf content. (In LITE projection.)
+                "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
+                "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+                "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+              },
+              "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
+              "viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
+              "epub": { # Information about epub content. (In LITE projection.)
+                "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
+                "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+                "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+              },
+              "accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
+            },
+            "searchInfo": { # Search result information related to this volume.
+              "textSnippet": "A String", # A text snippet containing the search query.
+            },
+            "saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
+              "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+              "retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
+                "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
+                "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+              },
+              "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+              "offers": [ # Offers available for this volume (sales and rentals).
+                {
+                  "rentalDuration": { # The rental duration (for rental offers only).
+                    "count": 3.14,
+                    "unit": "A String",
+                  },
+                  "retailPrice": { # Offer retail (=discounted) price in Micros
+                    "currencyCode": "A String",
+                    "amountInMicros": 3.14,
+                  },
+                  "listPrice": { # Offer list (=undiscounted) price in Micros.
+                    "currencyCode": "A String",
+                    "amountInMicros": 3.14,
+                  },
+                  "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
+                },
+              ],
+              "saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
+              "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+              "onSaleDate": "A String", # The date on which this book is available for sale.
+              "listPrice": { # Suggested retail price. (In LITE projection.)
+                "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
+                "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+              },
+            },
+            "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+            "selfLink": "A String", # URL to this resource. (In LITE projection.)
+            "volumeInfo": { # General volume information.
+              "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+              "pageCount": 42, # Total number of pages as per publisher metadata.
+              "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
+              "seriesInfo": {
+                "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
+                "kind": "books#volume_series_info", # Resource type.
+                "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
+                "volumeSeries": [
+                  {
+                    "orderNumber": 42, # The book order number in the series.
+                    "seriesId": "A String", # The series id.
+                    "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
+                      {
+                        "issueOrderNumber": 42,
+                        "issueDisplayNumber": "A String",
+                      },
+                    ],
+                    "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
+                  },
+                ],
+              },
+              "dimensions": { # Physical dimensions of this volume.
+                "width": "A String", # Width of this volume (in cm).
+                "thickness": "A String", # Thickness of this volume (in cm).
+                "height": "A String", # Height or length of this volume (in cm).
+              },
+              "previewLink": "A String", # URL to preview this volume on the Google Books site.
+              "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+              "industryIdentifiers": [ # Industry standard identifiers for this volume.
+                {
+                  "identifier": "A String", # Industry specific volume identifier.
+                  "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+                },
+              ],
+              "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
+              "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
+              "publishedDate": "A String", # Date of publication. (In LITE projection.)
+              "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+                "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+                "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+                "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+                "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+                "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+                "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+              },
+              "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+                "A String",
+              ],
+              "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+                "A String",
+              ],
+              "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+              "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
+              "readingModes": "", # The reading modes available for this volume.
+              "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
+              "title": "A String", # Volume title. (In LITE projection.)
+              "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+              "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+              "maturityRating": "A String",
+              "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
+              "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+              "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+              "ratingsCount": 42, # The number of review ratings for this volume.
+            },
+            "recommendedInfo": { # Recommendation related information for this volume.
+              "explanation": "A String", # A text explaining why this volume is recommended.
+            },
+            "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+            "layerInfo": { # What layers exist in this volume and high level information about them.
+              "layers": [ # A layer should appear here if and only if the layer exists for this book.
+                {
+                  "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
+                  "layerId": "A String", # The layer id of this layer (e.g. "geo").
+                },
+              ],
+            },
+            "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+              "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
+              "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
+              "acquisitionType": 42, # How this volume was acquired.
+              "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
+              "userUploadedVolumeInfo": {
+                "processingState": "A String",
+              },
+              "rentalPeriod": { # Period during this book is/was a valid rental.
+                "startUtcSec": "A String",
+                "endUtcSec": "A String",
+              },
+              "rentalState": "A String", # Whether this book is an active or an expired rental.
+              "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+              "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+                "kind": "books#readingPosition", # Resource type for a reading position.
+                "gbImagePosition": "A String", # Position in a volume for image-based content.
+                "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+                "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+                "volumeId": "A String", # Volume id associated with this reading position.
+                "pdfPosition": "A String", # Position in a PDF file.
+                "gbTextPosition": "A String", # Position in a volume for text-based content.
+              },
+              "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
+              "review": { # This user's review of this volume, if one exists.
+                "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+                "kind": "books#review", # Resource type for a review.
+                "author": { # Author of this review.
+                  "displayName": "A String", # Name of this person.
+                },
+                "title": "A String", # Title for this review.
+                "volumeId": "A String", # Volume that this review is for.
+                "content": "A String", # Review text.
+                "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+                  "extraDescription": "A String", # Extra text about the source of the review.
+                  "url": "A String", # URL of the source of the review.
+                  "description": "A String", # Name of the source.
+                },
+                "date": "A String", # Date of this review.
+                "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+                "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+              },
+              "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
+              "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
+              "copy": { # Copy/Paste accounting information.
+                "limitType": "A String",
+                "remainingCharacterCount": 42,
+                "updated": "A String",
+                "allowedCharacterCount": 42,
+              },
+              "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+              "isUploaded": True or False, # Whether or not this volume was user uploaded.
+              "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
+            },
+          },
+        ],
+      },
+    ],
+    "kind": "books#discovery#clusters", # Resorce type.
+    "totalClusters": 42,
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/books_v1.series.html b/docs/dyn/books_v1.series.html new file mode 100644 index 00000000000..011b1541679 --- /dev/null +++ b/docs/dyn/books_v1.series.html @@ -0,0 +1,110 @@ + + + +

Books API . series

+

Instance Methods

+

+ membership() +

+

Returns the membership Resource.

+ +

+ get(series_id)

+

Returns Series metadata for the given series ids.

+

Method Details

+
+ get(series_id) +
Returns Series metadata for the given series ids.
+
+Args:
+  series_id: string, String that identifies the series (required) (repeated)
+
+Returns:
+  An object of the form:
+
+    {
+    "series": [
+      {
+        "seriesId": "A String",
+        "bannerImageUrl": "A String",
+        "title": "A String",
+        "imageUrl": "A String",
+        "seriesType": "A String",
+      },
+    ],
+    "kind": "books#series", # Resource type.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/books_v1.series.membership.html b/docs/dyn/books_v1.series.membership.html new file mode 100644 index 00000000000..a8a5afd787e --- /dev/null +++ b/docs/dyn/books_v1.series.membership.html @@ -0,0 +1,309 @@ + + + +

Books API . series . membership

+

Instance Methods

+

+ get(series_id, page_token=None, page_size=None)

+

Returns Series membership data given the series id.

+

Method Details

+
+ get(series_id, page_token=None, page_size=None) +
Returns Series membership data given the series id.
+
+Args:
+  series_id: string, String that identifies the series (required)
+  page_token: string, The value of the nextToken from the previous page.
+  page_size: integer, Number of maximum results per page to be included in the response.
+
+Returns:
+  An object of the form:
+
+    {
+    "member": [
+      {
+        "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
+        "accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
+          "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
+          "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+          "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+          "downloadAccess": { # Information about a volume's download license access restrictions.
+            "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+            "kind": "books#downloadAccessRestriction", # Resource type.
+            "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+            "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+            "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+            "signature": "A String", # Response signature.
+            "volumeId": "A String", # Identifies the volume for which this entry applies.
+            "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+            "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+            "restricted": True or False, # Whether this volume has any download access restrictions.
+            "reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
+            "message": "A String", # Error/warning message.
+          },
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+          "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
+          "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
+          "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+          "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
+          "pdf": { # Information about pdf content. (In LITE projection.)
+            "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
+            "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+          },
+          "explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
+          "viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
+          "epub": { # Information about epub content. (In LITE projection.)
+            "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
+            "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+            "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+          },
+          "accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
+        },
+        "searchInfo": { # Search result information related to this volume.
+          "textSnippet": "A String", # A text snippet containing the search query.
+        },
+        "saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
+          "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+          "retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
+            "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+          "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+          "offers": [ # Offers available for this volume (sales and rentals).
+            {
+              "rentalDuration": { # The rental duration (for rental offers only).
+                "count": 3.14,
+                "unit": "A String",
+              },
+              "retailPrice": { # Offer retail (=discounted) price in Micros
+                "currencyCode": "A String",
+                "amountInMicros": 3.14,
+              },
+              "listPrice": { # Offer list (=undiscounted) price in Micros.
+                "currencyCode": "A String",
+                "amountInMicros": 3.14,
+              },
+              "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
+            },
+          ],
+          "saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
+          "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
+          "onSaleDate": "A String", # The date on which this book is available for sale.
+          "listPrice": { # Suggested retail price. (In LITE projection.)
+            "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
+            "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+          },
+        },
+        "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+        "selfLink": "A String", # URL to this resource. (In LITE projection.)
+        "volumeInfo": { # General volume information.
+          "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+          "pageCount": 42, # Total number of pages as per publisher metadata.
+          "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
+          "seriesInfo": {
+            "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
+            "kind": "books#volume_series_info", # Resource type.
+            "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
+            "volumeSeries": [
+              {
+                "orderNumber": 42, # The book order number in the series.
+                "seriesId": "A String", # The series id.
+                "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
+                  {
+                    "issueOrderNumber": 42,
+                    "issueDisplayNumber": "A String",
+                  },
+                ],
+                "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
+              },
+            ],
+          },
+          "dimensions": { # Physical dimensions of this volume.
+            "width": "A String", # Width of this volume (in cm).
+            "thickness": "A String", # Thickness of this volume (in cm).
+            "height": "A String", # Height or length of this volume (in cm).
+          },
+          "previewLink": "A String", # URL to preview this volume on the Google Books site.
+          "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+          "industryIdentifiers": [ # Industry standard identifiers for this volume.
+            {
+              "identifier": "A String", # Industry specific volume identifier.
+              "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+            },
+          ],
+          "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
+          "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
+          "publishedDate": "A String", # Date of publication. (In LITE projection.)
+          "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+            "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+            "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+            "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+            "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+            "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+            "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+          },
+          "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+            "A String",
+          ],
+          "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+            "A String",
+          ],
+          "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+          "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
+          "readingModes": "", # The reading modes available for this volume.
+          "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
+          "title": "A String", # Volume title. (In LITE projection.)
+          "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+          "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+          "maturityRating": "A String",
+          "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
+          "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+          "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
+          "ratingsCount": 42, # The number of review ratings for this volume.
+        },
+        "recommendedInfo": { # Recommendation related information for this volume.
+          "explanation": "A String", # A text explaining why this volume is recommended.
+        },
+        "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+        "layerInfo": { # What layers exist in this volume and high level information about them.
+          "layers": [ # A layer should appear here if and only if the layer exists for this book.
+            {
+              "volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
+              "layerId": "A String", # The layer id of this layer (e.g. "geo").
+            },
+          ],
+        },
+        "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+          "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
+          "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
+          "acquisitionType": 42, # How this volume was acquired.
+          "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
+          "userUploadedVolumeInfo": {
+            "processingState": "A String",
+          },
+          "rentalPeriod": { # Period during this book is/was a valid rental.
+            "startUtcSec": "A String",
+            "endUtcSec": "A String",
+          },
+          "rentalState": "A String", # Whether this book is an active or an expired rental.
+          "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+          "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+            "kind": "books#readingPosition", # Resource type for a reading position.
+            "gbImagePosition": "A String", # Position in a volume for image-based content.
+            "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+            "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+            "volumeId": "A String", # Volume id associated with this reading position.
+            "pdfPosition": "A String", # Position in a PDF file.
+            "gbTextPosition": "A String", # Position in a volume for text-based content.
+          },
+          "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
+          "review": { # This user's review of this volume, if one exists.
+            "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+            "kind": "books#review", # Resource type for a review.
+            "author": { # Author of this review.
+              "displayName": "A String", # Name of this person.
+            },
+            "title": "A String", # Title for this review.
+            "volumeId": "A String", # Volume that this review is for.
+            "content": "A String", # Review text.
+            "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+              "extraDescription": "A String", # Extra text about the source of the review.
+              "url": "A String", # URL of the source of the review.
+              "description": "A String", # Name of the source.
+            },
+            "date": "A String", # Date of this review.
+            "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+            "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+          },
+          "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
+          "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
+          "copy": { # Copy/Paste accounting information.
+            "limitType": "A String",
+            "remainingCharacterCount": 42,
+            "updated": "A String",
+            "allowedCharacterCount": 42,
+          },
+          "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+          "isUploaded": True or False, # Whether or not this volume was user uploaded.
+          "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
+        },
+      },
+    ],
+    "nextPageToken": "A String",
+    "kind": "books#series#membership", # Resorce type.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/books_v1.volumes.associated.html b/docs/dyn/books_v1.volumes.associated.html index 77c51d971c5..4e643626cee 100644 --- a/docs/dyn/books_v1.volumes.associated.html +++ b/docs/dyn/books_v1.volumes.associated.html @@ -182,6 +182,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -238,15 +256,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -258,6 +278,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -276,14 +297,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.volumes.html b/docs/dyn/books_v1.volumes.html index 962614dad06..821ab63ca7c 100644 --- a/docs/dyn/books_v1.volumes.html +++ b/docs/dyn/books_v1.volumes.html @@ -95,14 +95,14 @@

Instance Methods

Returns the useruploaded Resource.

- get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, partner=None)

+ get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)

Gets volume information for a single volume.

list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)

Performs a book search.

Method Details

- get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, partner=None) + get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)
Gets volume information for a single volume.
 
 Args:
@@ -114,6 +114,7 @@ 

Method Details

lite - Includes a subset of fields in volumeInfo and accessInfo. source: string, String to identify the originator of this request. country: string, ISO-3166-1 code to override the IP-based location. + includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false. partner: string, Brand results for partner ID. Returns: @@ -199,6 +200,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -255,15 +274,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -275,6 +296,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -293,14 +315,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }
@@ -431,6 +456,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -487,15 +530,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -507,6 +552,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -525,14 +571,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.volumes.mybooks.html b/docs/dyn/books_v1.volumes.mybooks.html index 8aa620d8359..22f295e6398 100644 --- a/docs/dyn/books_v1.volumes.mybooks.html +++ b/docs/dyn/books_v1.volumes.mybooks.html @@ -188,6 +188,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -244,15 +262,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -264,6 +284,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -282,14 +303,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.volumes.recommended.html b/docs/dyn/books_v1.volumes.recommended.html index 30496d3c0fd..8a96cca4ae1 100644 --- a/docs/dyn/books_v1.volumes.recommended.html +++ b/docs/dyn/books_v1.volumes.recommended.html @@ -179,6 +179,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -235,15 +253,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -255,6 +275,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -273,14 +294,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/books_v1.volumes.useruploaded.html b/docs/dyn/books_v1.volumes.useruploaded.html index 53e5c7f25c7..a1866998c40 100644 --- a/docs/dyn/books_v1.volumes.useruploaded.html +++ b/docs/dyn/books_v1.volumes.useruploaded.html @@ -180,6 +180,24 @@

Method Details

"subtitle": "A String", # Volume subtitle. (In LITE projection.) "pageCount": 42, # Total number of pages as per publisher metadata. "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. + "seriesInfo": { + "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. + "kind": "books#volume_series_info", # Resource type. + "shortSeriesBookTitle": "A String", # Short book title in the context of the series. + "volumeSeries": [ + { + "orderNumber": 42, # The book order number in the series. + "seriesId": "A String", # The series id. + "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus. + { + "issueOrderNumber": 42, + "issueDisplayNumber": "A String", + }, + ], + "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc. + }, + ], + }, "dimensions": { # Physical dimensions of this volume. "width": "A String", # Width of this volume (in cm). "thickness": "A String", # Thickness of this volume (in cm). @@ -236,15 +254,17 @@

Method Details

], }, "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) + "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family. "isInMyBooks": True or False, # Whether or not this volume is currently in "my books." - "rentalPeriod": { # Period during this book is/was a valid rental. - "startUtcSec": "A String", - "endUtcSec": "A String", - }, + "acquisitionType": 42, # How this volume was acquired. "updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format). "userUploadedVolumeInfo": { "processingState": "A String", }, + "rentalPeriod": { # Period during this book is/was a valid rental. + "startUtcSec": "A String", + "endUtcSec": "A String", + }, "rentalState": "A String", # Whether this book is an active or an expired rental. "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.) "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.) @@ -256,6 +276,7 @@

Method Details

"pdfPosition": "A String", # Position in a PDF file. "gbTextPosition": "A String", # Position in a volume for text-based content. }, + "isFamilySharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action. "review": { # This user's review of this volume, if one exists. "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. "kind": "books#review", # Resource type for a review. @@ -274,14 +295,17 @@

Method Details

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web. }, - "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) + "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing. + "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc. "copy": { # Copy/Paste accounting information. "limitType": "A String", "remainingCharacterCount": 42, "updated": "A String", "allowedCharacterCount": 42, }, + "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.) "isUploaded": True or False, # Whether or not this volume was user uploaded. + "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. }, }, ], diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index 9021ef41560..743e503c11b 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -255,7 +255,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -407,7 +407,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -554,7 +554,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -706,7 +706,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -855,7 +855,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1032,7 +1032,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1259,7 +1259,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1442,7 +1442,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1595,7 +1595,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1745,7 +1745,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -1900,7 +1900,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -2053,7 +2053,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { @@ -2203,7 +2203,7 @@

Method Details

"locked": false, # Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. "created": "A String", # Creation time of the event (as a RFC3339 timestamp). Read-only. "colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. - "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event. Optional. The default is False. + "anyoneCanAddSelf": false, # Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { diff --git a/docs/dyn/classroom_v1.courses.aliases.html b/docs/dyn/classroom_v1.courses.aliases.html index be44dc78910..a70187926da 100644 --- a/docs/dyn/classroom_v1.courses.aliases.html +++ b/docs/dyn/classroom_v1.courses.aliases.html @@ -76,28 +76,28 @@

Google Classroom API . create(courseId, body, x__xgafv=None)

-

Creates an alias to a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.

+

Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.

delete(courseId, alias, x__xgafv=None)

-

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias. * `NOT_FOUND` if the alias does not exist.

+

Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

-

Lists the aliases of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course. * `NOT_FOUND` if the course does not exist.

+

Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, x__xgafv=None) -
Creates an alias to a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.
+  
Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.
 
 Args:
-  courseId: string, The identifier of the course to alias. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  courseId: string, Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # Alternative identifier for a course. An alias uniquely identifies a course. It will be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and may only be created by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console Project ID that created the alias and may be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded.
-    "alias": "A String", # Alias string. The format of the string indicated the desired alias scoping. * "d:" indicates a domain-scoped alias. Example: d:math_101 * "p:" indicates a project-scoped alias. Example: p:abc123 This field has a maximum length of 256 characters.
+{ # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+    "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
   }
 
   x__xgafv: string, V1 error format.
@@ -105,18 +105,18 @@ 

Method Details

Returns: An object of the form: - { # Alternative identifier for a course. An alias uniquely identifies a course. It will be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and may only be created by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console Project ID that created the alias and may be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded. - "alias": "A String", # Alias string. The format of the string indicated the desired alias scoping. * "d:" indicates a domain-scoped alias. Example: d:math_101 * "p:" indicates a project-scoped alias. Example: p:abc123 This field has a maximum length of 256 characters. + { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. + "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. }
delete(courseId, alias, x__xgafv=None) -
Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias. * `NOT_FOUND` if the alias does not exist.
+  
Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.
 
 Args:
-  courseId: string, The identifier of the course whose alias should be deleted. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
-  alias: string, The alias to delete. This may not be the Classroom-assigned identifier. (required)
+  courseId: string, Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+  alias: string, Alias to delete. This may not be the Classroom-assigned identifier. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -128,13 +128,13 @@ 

Method Details

list(courseId, pageSize=None, x__xgafv=None, pageToken=None) -
Lists the aliases of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course. * `NOT_FOUND` if the course does not exist.
+  
Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
 
 Args:
-  courseId: string, The identifier of the course. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  courseId: string, The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
   x__xgafv: string, V1 error format.
-  pageToken: string, [nextPageToken][google.classroom.v1.ListCourseAliasesResponse.next_page_token] value returned from a previous [list][google.classroom.v1.Courses.ListCourseAliases] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Courses.ListCourseAliases] request must be identical to the one which resulted in this token.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
 
 Returns:
   An object of the form:
@@ -142,8 +142,8 @@ 

Method Details

{ # Response when listing course aliases. "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. "aliases": [ # The course aliases. - { # Alternative identifier for a course. An alias uniquely identifies a course. It will be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and may only be created by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console Project ID that created the alias and may be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a previous one has succeeded. - "alias": "A String", # Alias string. The format of the string indicated the desired alias scoping. * "d:" indicates a domain-scoped alias. Example: d:math_101 * "p:" indicates a project-scoped alias. Example: p:abc123 This field has a maximum length of 256 characters. + { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded. + "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. }, ], }
diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html index 24d450fc6fb..0c0451fe0b3 100644 --- a/docs/dyn/classroom_v1.courses.html +++ b/docs/dyn/classroom_v1.courses.html @@ -91,29 +91,29 @@

Instance Methods

create(body, x__xgafv=None)

-

Creates a course. The user specified as the primary teacher in `primary_teacher_id` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses. * `NOT_FOUND` if the primary teacher is not a valid user. * `ALREADY_EXISTS` if an alias was specified and already exists.

+

Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.

delete(id, x__xgafv=None)

-

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course. * `NOT_FOUND` if no course exists with the requested ID.

+

Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

get(id, x__xgafv=None)

-

Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course. * `NOT_FOUND` if no course exists with the requested ID.

+

Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

list(studentId=None, pageSize=None, teacherId=None, pageToken=None, x__xgafv=None)

-

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

+

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(id, body, updateMask=None, x__xgafv=None)

-

Updates one or more fields a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.

+

Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

update(id, body, x__xgafv=None)

-

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID.

+

Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable

Method Details

create(body, x__xgafv=None) -
Creates a course. The user specified as the primary teacher in `primary_teacher_id` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses. * `NOT_FOUND` if the primary teacher is not a valid user. * `ALREADY_EXISTS` if an alias was specified and already exists.
+  
Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
 
 Args:
   body: object, The request body. (required)
@@ -121,17 +121,17 @@ 

Method Details

{ # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. } x__xgafv: string, V1 error format. @@ -141,26 +141,26 @@

Method Details

{ # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. }
delete(id, x__xgafv=None) -
Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course. * `NOT_FOUND` if no course exists with the requested ID.
+  
Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
 
 Args:
-  id: string, Identifier of the course to delete. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -172,10 +172,10 @@ 

Method Details

get(id, x__xgafv=None) -
Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course. * `NOT_FOUND` if no course exists with the requested ID.
+  
Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
 
 Args:
-  id: string, Identifier of the course to return. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -183,29 +183,29 @@ 

Method Details

{ # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. }
list(studentId=None, pageSize=None, teacherId=None, pageToken=None, x__xgafv=None) -
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
+  
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
 
 Args:
-  studentId: string, Restricts returned courses to those having a student with the specified identifier, or an alias that identifies a student. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+  studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
   pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
-  teacherId: string, Restricts returned courses to those having a teacher with the specified identifier, or an alias that identifies a teacher. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
-  pageToken: string, [nextPageToken][google.classroom.v1.ListCoursesResponse.next_page_token] value returned from a previous [list][google.classroom.v1.Courses.ListCourses] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Courses.ListCourses] request must be identical to the one which resulted in this token.
+  teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -213,20 +213,20 @@ 

Method Details

{ # Response when listing courses. "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. - "courses": [ # Courses that match the request. + "courses": [ # Courses that match the list request. { # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. }, ], }
@@ -248,29 +248,29 @@

Method Details

patch(id, body, updateMask=None, x__xgafv=None) -
Updates one or more fields a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.
+  
Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
 
 Args:
-  id: string, Identifier of the course to update. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A Course in Classroom.
   "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only.
-  "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
+  "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
   "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
   "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only.
-  "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
+  "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
   "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only.
-  "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string.
-  "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`.
-  "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error.
-  "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error.
-  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
-  "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+  "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+  "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+  "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error.
+  "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error.
+  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+  "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
 }
 
-  updateMask: string, Mask which identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. Valid fields are listed below: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this should be specified as `updateMask=,,...`
+  updateMask: string, Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -278,42 +278,42 @@ 

Method Details

{ # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. }
update(id, body, x__xgafv=None) -
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID.
+  
Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
 
 Args:
-  id: string, Identifier of the course to update. This may either be the Classroom-assigned identifier or an [alias][google.classroom.v1.CourseAlias]. (required)
+  id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A Course in Classroom.
   "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only.
-  "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
+  "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.
   "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only.
   "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only.
-  "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
+  "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
   "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only.
-  "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string.
-  "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`.
-  "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error.
-  "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error.
-  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
-  "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+  "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
+  "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
+  "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error.
+  "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error.
+  "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
+  "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
 }
 
   x__xgafv: string, V1 error format.
@@ -323,17 +323,17 @@ 

Method Details

{ # A Course in Classroom. "updateTime": "A String", # Time of the most recent update to this course. Specifying this field in a course update mask will result in an error. Read-only. - "description": "A String", # Optional description. For example, "We'll be learning about about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. + "description": "A String", # Optional description. For example, "We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters. "alternateLink": "A String", # Absolute link to this course in the Classroom web UI. Read-only. "enrollmentCode": "A String", # Enrollment code to use when joining this course. Specifying this field in a course update mask will result in an error. Read-only. - "section": "A String", # Section of the course For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. + "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters. "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only. - "name": "A String", # Name of the course. For example, "10th Grade Biology". This is required and must be between 1 and 750 characters and a valid UTF-8 string. - "courseState": "A String", # State of the course. If unspecified, the default state will be `PROVISIONED`. - "ownerId": "A String", # The identifier of the owner (and primary teacher) of a course. When specified as a parameter of CreateCourseRequest, this field is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update mask will result in an error. - "id": "A String", # Unique identifier for this course assigned by Classroom. You may optionally set this to an [alias string][google.classroom.v1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.CreateCourse], creating a corresponding alias. The `ID` cannot be updated after a course is created. Specifying this field in a course update mask will result in an error. - "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology" If set, this field must be a valid UTF-8 string and no longer than 3600 characters. - "room": "A String", # Optional room location. For example, "301" If set, this field must be a valid UTF-8 string and no longer than 650 characters. + "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string. + "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`. + "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask will result in an `INVALID_ARGUMENT` error. + "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask will result in an error. + "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters. + "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters. }
diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html index 2a5957b6f42..4c346d04c2b 100644 --- a/docs/dyn/classroom_v1.courses.students.html +++ b/docs/dyn/classroom_v1.courses.students.html @@ -76,83 +76,83 @@

Google Classroom API . create(courseId, body, enrollmentCode=None, x__xgafv=None)

-

Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a student or student in the course.

+

Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

delete(courseId, userId, x__xgafv=None)

-

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

+

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

get(courseId, userId, x__xgafv=None)

-

Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

+

Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

-

Returns a list of students of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.

+

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, enrollmentCode=None, x__xgafv=None) -
Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a student or student in the course.
+  
Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
 
 Args:
-  courseId: string, Identifier of the course to create the student in. This may either be the Classroom-assigned identifier or an alias. (required)
+  courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Student in a course.
-    "courseId": "A String", # Unique identifier of the course. Read-only
-    "profile": { # Global information for a user. # Global user information for the student. Read-only
-      "permissions": [ # Global permissions of the user. Read-only
+    "courseId": "A String", # Identifier of the course. Read-only.
+    "profile": { # Global information for a user. # Global user information for the student. Read-only.
+      "permissions": [ # Global permissions of the user. Read-only.
         { # Global user permission description.
           "permission": "A String", # Permission value.
         },
       ],
-      "photoUrl": "A String", # Url of user's profile photo. Read-only
-      "emailAddress": "A String", # E-mail address of the user. Read-only
-      "id": "A String", # Unique identifier of the user. Read-only
-      "name": { # Details of the user's name. # Name of the user. Read-only
-        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-        "givenName": "A String", # The user's first name. Read-only
-        "familyName": "A String", # The user's last name. Read-only
+      "photoUrl": "A String", # URL of user's profile photo. Read-only.
+      "emailAddress": "A String", # Email address of the user. Read-only.
+      "id": "A String", # Identifier of the user. Read-only.
+      "name": { # Details of the user's name. # Name of the user. Read-only.
+        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+        "givenName": "A String", # The user's first name. Read-only.
+        "familyName": "A String", # The user's last name. Read-only.
       },
     },
-    "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+    "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
   }
 
-  enrollmentCode: string, Enrollment code of the course to create the student in. This is required if [userId][google.classroom.v1.Student.user_id] corresponds to the requesting user; this may be omitted if the requesting user has administrative permissions to create students for any user.
+  enrollmentCode: string, Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
     { # Student in a course.
-      "courseId": "A String", # Unique identifier of the course. Read-only
-      "profile": { # Global information for a user. # Global user information for the student. Read-only
-        "permissions": [ # Global permissions of the user. Read-only
+      "courseId": "A String", # Identifier of the course. Read-only.
+      "profile": { # Global information for a user. # Global user information for the student. Read-only.
+        "permissions": [ # Global permissions of the user. Read-only.
           { # Global user permission description.
             "permission": "A String", # Permission value.
           },
         ],
-        "photoUrl": "A String", # Url of user's profile photo. Read-only
-        "emailAddress": "A String", # E-mail address of the user. Read-only
-        "id": "A String", # Unique identifier of the user. Read-only
-        "name": { # Details of the user's name. # Name of the user. Read-only
-          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-          "givenName": "A String", # The user's first name. Read-only
-          "familyName": "A String", # The user's last name. Read-only
+        "photoUrl": "A String", # URL of user's profile photo. Read-only.
+        "emailAddress": "A String", # Email address of the user. Read-only.
+        "id": "A String", # Identifier of the user. Read-only.
+        "name": { # Details of the user's name. # Name of the user. Read-only.
+          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+          "givenName": "A String", # The user's first name. Read-only.
+          "familyName": "A String", # The user's last name. Read-only.
         },
       },
-      "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
     }
delete(courseId, userId, x__xgafv=None) -
Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+  
Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
-  userId: string, Identifier of the student to delete, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+  userId: string, Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -164,70 +164,70 @@ 

Method Details

get(courseId, userId, x__xgafv=None) -
Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+  
Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
-  userId: string, Identifier of the student to return, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+  userId: string, Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
     { # Student in a course.
-      "courseId": "A String", # Unique identifier of the course. Read-only
-      "profile": { # Global information for a user. # Global user information for the student. Read-only
-        "permissions": [ # Global permissions of the user. Read-only
+      "courseId": "A String", # Identifier of the course. Read-only.
+      "profile": { # Global information for a user. # Global user information for the student. Read-only.
+        "permissions": [ # Global permissions of the user. Read-only.
           { # Global user permission description.
             "permission": "A String", # Permission value.
           },
         ],
-        "photoUrl": "A String", # Url of user's profile photo. Read-only
-        "emailAddress": "A String", # E-mail address of the user. Read-only
-        "id": "A String", # Unique identifier of the user. Read-only
-        "name": { # Details of the user's name. # Name of the user. Read-only
-          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-          "givenName": "A String", # The user's first name. Read-only
-          "familyName": "A String", # The user's last name. Read-only
+        "photoUrl": "A String", # URL of user's profile photo. Read-only.
+        "emailAddress": "A String", # Email address of the user. Read-only.
+        "id": "A String", # Identifier of the user. Read-only.
+        "name": { # Details of the user's name. # Name of the user. Read-only.
+          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+          "givenName": "A String", # The user's first name. Read-only.
+          "familyName": "A String", # The user's last name. Read-only.
         },
       },
-      "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
     }
list(courseId, pageSize=None, x__xgafv=None, pageToken=None) -
Returns a list of students of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.
+  
Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
   x__xgafv: string, V1 error format.
-  pageToken: string, [nextPageToken][google.classroom.v1.ListStudentsResponse.next_page_token] value returned from a previous [list][google.classroom.v1.Users.ListStudents] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListStudents] request must be identical to the one which resulted in this token.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
 
 Returns:
   An object of the form:
 
     { # Response when listing students.
-    "students": [ # The students who match the list request.
+    "students": [ # Students who match the list request.
       { # Student in a course.
-          "courseId": "A String", # Unique identifier of the course. Read-only
-          "profile": { # Global information for a user. # Global user information for the student. Read-only
-            "permissions": [ # Global permissions of the user. Read-only
+          "courseId": "A String", # Identifier of the course. Read-only.
+          "profile": { # Global information for a user. # Global user information for the student. Read-only.
+            "permissions": [ # Global permissions of the user. Read-only.
               { # Global user permission description.
                 "permission": "A String", # Permission value.
               },
             ],
-            "photoUrl": "A String", # Url of user's profile photo. Read-only
-            "emailAddress": "A String", # E-mail address of the user. Read-only
-            "id": "A String", # Unique identifier of the user. Read-only
-            "name": { # Details of the user's name. # Name of the user. Read-only
-              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-              "givenName": "A String", # The user's first name. Read-only
-              "familyName": "A String", # The user's last name. Read-only
+            "photoUrl": "A String", # URL of user's profile photo. Read-only.
+            "emailAddress": "A String", # Email address of the user. Read-only.
+            "id": "A String", # Identifier of the user. Read-only.
+            "name": { # Details of the user's name. # Name of the user. Read-only.
+              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+              "givenName": "A String", # The user's first name. Read-only.
+              "familyName": "A String", # The user's last name. Read-only.
             },
           },
-          "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
+          "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
         },
     ],
     "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
diff --git a/docs/dyn/classroom_v1.courses.teachers.html b/docs/dyn/classroom_v1.courses.teachers.html
index a862bed2635..7fda74e5c50 100644
--- a/docs/dyn/classroom_v1.courses.teachers.html
+++ b/docs/dyn/classroom_v1.courses.teachers.html
@@ -76,47 +76,47 @@ 

Google Classroom API . create(courseId, body, x__xgafv=None)

-

Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

+

Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

delete(courseId, userId, x__xgafv=None)

-

Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

+

Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.

get(courseId, userId, x__xgafv=None)

-

Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

+

Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.

list(courseId, pageSize=None, x__xgafv=None, pageToken=None)

-

Returns a list of teachers of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.

+

Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(courseId, body, x__xgafv=None) -
Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
+  
Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Teacher of a course.
-    "courseId": "A String", # Unique identifier of the course. Read-only
-    "profile": { # Global information for a user. # Global user information for the teacher. Read-only
-      "permissions": [ # Global permissions of the user. Read-only
+    "courseId": "A String", # Identifier of the course. Read-only.
+    "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
+      "permissions": [ # Global permissions of the user. Read-only.
         { # Global user permission description.
           "permission": "A String", # Permission value.
         },
       ],
-      "photoUrl": "A String", # Url of user's profile photo. Read-only
-      "emailAddress": "A String", # E-mail address of the user. Read-only
-      "id": "A String", # Unique identifier of the user. Read-only
-      "name": { # Details of the user's name. # Name of the user. Read-only
-        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-        "givenName": "A String", # The user's first name. Read-only
-        "familyName": "A String", # The user's last name. Read-only
+      "photoUrl": "A String", # URL of user's profile photo. Read-only.
+      "emailAddress": "A String", # Email address of the user. Read-only.
+      "id": "A String", # Identifier of the user. Read-only.
+      "name": { # Details of the user's name. # Name of the user. Read-only.
+        "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+        "givenName": "A String", # The user's first name. Read-only.
+        "familyName": "A String", # The user's last name. Read-only.
       },
     },
-    "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the teacher. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user
+    "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
   }
 
   x__xgafv: string, V1 error format.
@@ -125,33 +125,33 @@ 

Method Details

An object of the form: { # Teacher of a course. - "courseId": "A String", # Unique identifier of the course. Read-only - "profile": { # Global information for a user. # Global user information for the teacher. Read-only - "permissions": [ # Global permissions of the user. Read-only + "courseId": "A String", # Identifier of the course. Read-only. + "profile": { # Global information for a user. # Global user information for the teacher. Read-only. + "permissions": [ # Global permissions of the user. Read-only. { # Global user permission description. "permission": "A String", # Permission value. }, ], - "photoUrl": "A String", # Url of user's profile photo. Read-only - "emailAddress": "A String", # E-mail address of the user. Read-only - "id": "A String", # Unique identifier of the user. Read-only - "name": { # Details of the user's name. # Name of the user. Read-only - "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only - "givenName": "A String", # The user's first name. Read-only - "familyName": "A String", # The user's last name. Read-only + "photoUrl": "A String", # URL of user's profile photo. Read-only. + "emailAddress": "A String", # Email address of the user. Read-only. + "id": "A String", # Identifier of the user. Read-only. + "name": { # Details of the user's name. # Name of the user. Read-only. + "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only. + "givenName": "A String", # The user's first name. Read-only. + "familyName": "A String", # The user's last name. Read-only. }, }, - "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the teacher. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user + "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user }
delete(courseId, userId, x__xgafv=None) -
Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
+  
Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
-  userId: string, Identifier of the teacher to delete, or an alias the identifies the user. the following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+  userId: string, Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -163,71 +163,71 @@ 

Method Details

get(courseId, userId, x__xgafv=None) -
Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
+  
Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
-  userId: string, Identifier of the teacher to return, or an alias the identifies the user. the following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+  userId: string, Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
     { # Teacher of a course.
-      "courseId": "A String", # Unique identifier of the course. Read-only
-      "profile": { # Global information for a user. # Global user information for the teacher. Read-only
-        "permissions": [ # Global permissions of the user. Read-only
+      "courseId": "A String", # Identifier of the course. Read-only.
+      "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
+        "permissions": [ # Global permissions of the user. Read-only.
           { # Global user permission description.
             "permission": "A String", # Permission value.
           },
         ],
-        "photoUrl": "A String", # Url of user's profile photo. Read-only
-        "emailAddress": "A String", # E-mail address of the user. Read-only
-        "id": "A String", # Unique identifier of the user. Read-only
-        "name": { # Details of the user's name. # Name of the user. Read-only
-          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-          "givenName": "A String", # The user's first name. Read-only
-          "familyName": "A String", # The user's last name. Read-only
+        "photoUrl": "A String", # URL of user's profile photo. Read-only.
+        "emailAddress": "A String", # Email address of the user. Read-only.
+        "id": "A String", # Identifier of the user. Read-only.
+        "name": { # Details of the user's name. # Name of the user. Read-only.
+          "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+          "givenName": "A String", # The user's first name. Read-only.
+          "familyName": "A String", # The user's last name. Read-only.
         },
       },
-      "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the teacher. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user
+      "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
     }
list(courseId, pageSize=None, x__xgafv=None, pageToken=None) -
Returns a list of teachers of this course that the requester is permitted to view. Fails with `NOT_FOUND` if the course does not exist.
+  
Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
 
 Args:
-  courseId: string, Unique identifier of the course. This may either be the Classroom-assigned identifier or an alias. (required)
+  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
   pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
   x__xgafv: string, V1 error format.
-  pageToken: string, [nextPageToken][google.classroom.v1.ListTeachersResponse.next_page_token] value returned from a previous [list][google.classroom.v1.Users.ListTeachers] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListTeachers] request must be identical to the one which resulted in this token.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
 
 Returns:
   An object of the form:
 
     { # Response when listing teachers.
     "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
-    "teachers": [ # The teachers who match the list request.
+    "teachers": [ # Teachers who match the list request.
       { # Teacher of a course.
-          "courseId": "A String", # Unique identifier of the course. Read-only
-          "profile": { # Global information for a user. # Global user information for the teacher. Read-only
-            "permissions": [ # Global permissions of the user. Read-only
+          "courseId": "A String", # Identifier of the course. Read-only.
+          "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
+            "permissions": [ # Global permissions of the user. Read-only.
               { # Global user permission description.
                 "permission": "A String", # Permission value.
               },
             ],
-            "photoUrl": "A String", # Url of user's profile photo. Read-only
-            "emailAddress": "A String", # E-mail address of the user. Read-only
-            "id": "A String", # Unique identifier of the user. Read-only
-            "name": { # Details of the user's name. # Name of the user. Read-only
-              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-              "givenName": "A String", # The user's first name. Read-only
-              "familyName": "A String", # The user's last name. Read-only
+            "photoUrl": "A String", # URL of user's profile photo. Read-only.
+            "emailAddress": "A String", # Email address of the user. Read-only.
+            "id": "A String", # Identifier of the user. Read-only.
+            "name": { # Details of the user's name. # Name of the user. Read-only.
+              "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+              "givenName": "A String", # The user's first name. Read-only.
+              "familyName": "A String", # The user's last name. Read-only.
             },
           },
-          "userId": "A String", # The identifier of the user. When specified as a parameter of request, this field may be set to an alias that identifies the teacher. The following are supported: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user
+          "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
         },
     ],
   }
diff --git a/docs/dyn/classroom_v1.invitations.html b/docs/dyn/classroom_v1.invitations.html index 2af1da62775..326de5998a9 100644 --- a/docs/dyn/classroom_v1.invitations.html +++ b/docs/dyn/classroom_v1.invitations.html @@ -76,26 +76,26 @@

Google Classroom API . accept(id, x__xgafv=None)

-

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

+

Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.

create(body, x__xgafv=None)

-

Creates a invitation. Only one invitation for a user and course may exist at a time. Delete and recreate an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course. * `NOT_FOUND` if the course or the user does not exist. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

+

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

delete(id, x__xgafv=None)

-

Deletes a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

+

Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

get(id, x__xgafv=None)

-

Returns a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.

+

Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.

list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None)

-

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the request. *Note:* At least one of `user_id` or `course_id` must be supplied.

+

Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

accept(id, x__xgafv=None) -
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.
+  
Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
 
 Args:
   id: string, Identifier of the invitation to accept. (required)
@@ -110,7 +110,7 @@ 

Method Details

create(body, x__xgafv=None) -
Creates a invitation. Only one invitation for a user and course may exist at a time. Delete and recreate an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course. * `NOT_FOUND` if the course or the user does not exist. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
+  
Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
 
 Args:
   body: object, The request body. (required)
@@ -119,8 +119,8 @@ 

Method Details

{ # An invitation to join a course. "courseId": "A String", # Identifier of the course to invite the user to. "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. - "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this may be set to an alias that identifies the user to invite. The supported aliases are: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user - "id": "A String", # Unique identifier assigned by Classroom. Read-only + "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + "id": "A String", # Identifier assigned by Classroom. Read-only. } x__xgafv: string, V1 error format. @@ -131,14 +131,14 @@

Method Details

{ # An invitation to join a course. "courseId": "A String", # Identifier of the course to invite the user to. "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. - "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this may be set to an alias that identifies the user to invite. The supported aliases are: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user - "id": "A String", # Unique identifier assigned by Classroom. Read-only + "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + "id": "A String", # Identifier assigned by Classroom. Read-only. }
delete(id, x__xgafv=None) -
Deletes a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.
+  
Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
 
 Args:
   id: string, Identifier of the invitation to delete. (required)
@@ -153,7 +153,7 @@ 

Method Details

get(id, x__xgafv=None) -
Returns a invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.
+  
Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
 
 Args:
   id: string, Identifier of the invitation to return. (required)
@@ -165,33 +165,33 @@ 

Method Details

{ # An invitation to join a course. "courseId": "A String", # Identifier of the course to invite the user to. "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. - "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this may be set to an alias that identifies the user to invite. The supported aliases are: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user - "id": "A String", # Unique identifier assigned by Classroom. Read-only + "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + "id": "A String", # Identifier assigned by Classroom. Read-only. }
list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None) -
Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the request. *Note:* At least one of `user_id` or `course_id` must be supplied.
+  
Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.
 
 Args:
-  pageSize: integer, The maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
+  pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
   courseId: string, Restricts returned invitations to those for a course with the specified identifier.
-  userId: string, Restricts returned invitations to those for a specific user. This may be the unique identifier for the user or an alias. The supported aliases are: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user
+  userId: string, Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
   x__xgafv: string, V1 error format.
-  pageToken: string, [nextPageToken][google.classroom.v1.ListInvitationsRespnse.next_page_token] value returned from a previous [list][google.classroom.v1.Users.ListInvitations] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListInvitations] request must be identical to the one which resulted in this token.
+  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
 
 Returns:
   An object of the form:
 
     { # Response when listing invitations.
     "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
-    "invitations": [ # Invitations that match the request.
+    "invitations": [ # Invitations that match the list request.
       { # An invitation to join a course.
           "courseId": "A String", # Identifier of the course to invite the user to.
           "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
-          "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this may be set to an alias that identifies the user to invite. The supported aliases are: * the e-mail address of the user * the string literal `"me"`, indicating that the requesting user
-          "id": "A String", # Unique identifier assigned by Classroom. Read-only
+          "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
+          "id": "A String", # Identifier assigned by Classroom. Read-only.
         },
     ],
   }
diff --git a/docs/dyn/classroom_v1.userProfiles.html b/docs/dyn/classroom_v1.userProfiles.html index c1fbe4abeb3..cc4d4498b13 100644 --- a/docs/dyn/classroom_v1.userProfiles.html +++ b/docs/dyn/classroom_v1.userProfiles.html @@ -76,32 +76,32 @@

Google Classroom API . get(userId, x__xgafv=None)

-

Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile. * `NOT_FOUND` if the profile does not exist.

+

Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.

Method Details

get(userId, x__xgafv=None) -
Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile. * `NOT_FOUND` if the profile does not exist.
+  
Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile or if no profile exists with the requested ID or for access errors.
 
 Args:
-  userId: string, Identifier of the profile to return, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `"me"`, indicating the requesting user (required)
+  userId: string, Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
     { # Global information for a user.
-    "permissions": [ # Global permissions of the user. Read-only
+    "permissions": [ # Global permissions of the user. Read-only.
       { # Global user permission description.
         "permission": "A String", # Permission value.
       },
     ],
-    "photoUrl": "A String", # Url of user's profile photo. Read-only
-    "emailAddress": "A String", # E-mail address of the user. Read-only
-    "id": "A String", # Unique identifier of the user. Read-only
-    "name": { # Details of the user's name. # Name of the user. Read-only
-      "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only
-      "givenName": "A String", # The user's first name. Read-only
-      "familyName": "A String", # The user's last name. Read-only
+    "photoUrl": "A String", # URL of user's profile photo. Read-only.
+    "emailAddress": "A String", # Email address of the user. Read-only.
+    "id": "A String", # Identifier of the user. Read-only.
+    "name": { # Details of the user's name. # Name of the user. Read-only.
+      "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
+      "givenName": "A String", # The user's first name. Read-only.
+      "familyName": "A String", # The user's last name. Read-only.
     },
   }
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html index c0d6ea12d80..27dc5dc33f0 100644 --- a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html +++ b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html @@ -75,147 +75,153 @@

Google Cloud Debugger API . controller . debuggees . breakpoints

Instance Methods

- list(debuggeeId, waitToken=None, x__xgafv=None)

-

Returns the list of all active breakpoints for the specified debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line the breakpoint was set to, but that doesn't change the breakpoint semantics. Thus, an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember breakpoints that are complete until the controller removes them from the active list to avoid setting those breakpoints again.

+ list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None)

+

Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.

update(debuggeeId, id, body, x__xgafv=None)

-

Updates the breakpoint state or mutable fields. The entire Breakpoint protobuf must be sent back to the controller. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the 'location', 'condition' and 'expression' fields should not alter the breakpoint semantics. They are restricted to changes such as canonicalizing a value or snapping the location to the correct line of code.

+

Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expression` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.

Method Details

- list(debuggeeId, waitToken=None, x__xgafv=None) -
Returns the list of all active breakpoints for the specified debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line the breakpoint was set to, but that doesn't change the breakpoint semantics. Thus, an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember breakpoints that are complete until the controller removes them from the active list to avoid setting those breakpoints again.
+    list(debuggeeId, successOnTimeout=None, waitToken=None, x__xgafv=None)
+  
Returns the list of all active breakpoints for the debuggee. The breakpoint specification (location, condition, and expression fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again.
 
 Args:
   debuggeeId: string, Identifies the debuggee. (required)
-  waitToken: string, A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response. The error code google.rpc.Code.ABORTED is returned on wait timeout (which does not require the agent to re-register with the server)
+  successOnTimeout: boolean, If set to `true`, returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired (recommended). If set to `false`, returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired (deprecated).
+  waitToken: string, A wait token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server selected timeout has expired. The value should be set from the last returned response.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # The response of listing active breakpoints.
+    { # Response for listing active breakpoints.
+    "waitExpired": True or False, # The `wait_expired` field is set to true by the server when the request times out and the field `success_on_timeout` is set to true.
     "nextWaitToken": "A String", # A wait token that can be used in the next method call to block until the list of breakpoints changes.
-    "breakpoints": [ # List of all active breakpoints. The fields 'id' and 'location' are guranteed to be set on each breakpoint.
+    "breakpoints": [ # List of all active breakpoints. The fields `id` and `location` are guaranteed to be set on each breakpoint.
       { # Represents the breakpoint specification, status and results.
-        "userEmail": "A String", # The e-mail of the user that created this breakpoint
-        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ...
+        "userEmail": "A String", # E-mail address of the user that created this breakpoint
+        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
           "isError": True or False, # Distinguishes errors from informational messages.
           "refersTo": "A String", # Reference to which the message applies.
           "description": { # Represents a message with parameters. # Status message text.
             "parameters": [ # Optional parameters to be embedded into the message.
               "A String",
             ],
-            "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
           },
         },
-        "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ].
-        "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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.
-          { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-              # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-            "members": [ # The members contained or pointed to by the variable.
-              # Object with schema name: Variable
-            ],
-            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+        "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
+        "variableTable": [ # 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.
+          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
               "isError": True or False, # Distinguishes errors from informational messages.
               "refersTo": "A String", # Reference to which the message applies.
               "description": { # Represents a message with parameters. # Status message text.
                 "parameters": [ # Optional parameters to be embedded into the message.
                   "A String",
                 ],
-                "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
               },
             },
-            "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-            "name": "A String", # The name of the variable, if any.
-            "value": "A String", # The simple value of the variable.
+            "name": "A String", # Name of the variable, if any.
+            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+            "value": "A String", # Simple value of the variable.
+            "members": [ # Members contained or pointed to by the variable.
+              # Object with schema name: Variable
+            ],
+            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
           },
         ],
-        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG".
-        "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution.
-        "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution.
+        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
+        "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
+        "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
         "stackFrames": [ # The stack at breakpoint time.
           { # Represents a stack frame context.
-            "function": "A String", # The unmangled function name at the call site.
-            "location": { # Represents a location in the source code. # The source location of the call site.
-              "path": "A String", # A path to the source file within the source context of the target binary.
-              "line": 42, # The line inside the file (first line value is '1').
+            "function": "A String", # Demangled function name at the call site.
+            "location": { # Represents a location in the source code. # Source location of the call site.
+              "path": "A String", # Path to the source file within the source context of the target binary.
+              "line": 42, # Line inside the file. The first line in the file has the value `1`.
             },
-            "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
-              { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                  # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-                "members": [ # The members contained or pointed to by the variable.
-                  # Object with schema name: Variable
-                ],
-                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+            "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
+              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                   "isError": True or False, # Distinguishes errors from informational messages.
                   "refersTo": "A String", # Reference to which the message applies.
                   "description": { # Represents a message with parameters. # Status message text.
                     "parameters": [ # Optional parameters to be embedded into the message.
                       "A String",
                     ],
-                    "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                   },
                 },
-                "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-                "name": "A String", # The name of the variable, if any.
-                "value": "A String", # The simple value of the variable.
-              },
-            ],
-            "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames.
-              { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                  # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-                "members": [ # The members contained or pointed to by the variable.
+                "name": "A String", # Name of the variable, if any.
+                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+                "value": "A String", # Simple value of the variable.
+                "members": [ # Members contained or pointed to by the variable.
                   # Object with schema name: Variable
                 ],
-                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
+              },
+            ],
+            "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
+              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                   "isError": True or False, # Distinguishes errors from informational messages.
                   "refersTo": "A String", # Reference to which the message applies.
                   "description": { # Represents a message with parameters. # Status message text.
                     "parameters": [ # Optional parameters to be embedded into the message.
                       "A String",
                     ],
-                    "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                   },
                 },
-                "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-                "name": "A String", # The name of the variable, if any.
-                "value": "A String", # The simple value of the variable.
+                "name": "A String", # Name of the variable, if any.
+                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+                "value": "A String", # Simple value of the variable.
+                "members": [ # Members contained or pointed to by the variable.
+                  # Object with schema name: Variable
+                ],
+                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
               },
             ],
           },
         ],
-        "location": { # Represents a location in the source code. # The breakpoint source location.
-          "path": "A String", # A path to the source file within the source context of the target binary.
-          "line": 42, # The line inside the file (first line value is '1').
+        "location": { # Represents a location in the source code. # Breakpoint source location.
+          "path": "A String", # Path to the source file within the source context of the target binary.
+          "line": 42, # Line inside the file. The first line in the file has the value `1`.
         },
-        "action": "A String", # Defines what to do when the breakpoint hits.
-        "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements.
+        "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
+        "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
           "A String",
         ],
         "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
-        "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.
-          { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-              # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-            "members": [ # The members contained or pointed to by the variable.
-              # Object with schema name: Variable
-            ],
-            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+        "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
+          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
               "isError": True or False, # Distinguishes errors from informational messages.
               "refersTo": "A String", # Reference to which the message applies.
               "description": { # Represents a message with parameters. # Status message text.
                 "parameters": [ # Optional parameters to be embedded into the message.
                   "A String",
                 ],
-                "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
               },
             },
-            "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-            "name": "A String", # The name of the variable, if any.
-            "value": "A String", # The simple value of the variable.
+            "name": "A String", # Name of the variable, if any.
+            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+            "value": "A String", # Simple value of the variable.
+            "members": [ # Members contained or pointed to by the variable.
+              # Object with schema name: Variable
+            ],
+            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
           },
         ],
         "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
-        "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
+        "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
       },
     ],
   }
@@ -223,7 +229,7 @@

Method Details

update(debuggeeId, id, body, x__xgafv=None) -
Updates the breakpoint state or mutable fields. The entire Breakpoint protobuf must be sent back to the controller. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the 'location', 'condition' and 'expression' fields should not alter the breakpoint semantics. They are restricted to changes such as canonicalizing a value or snapping the location to the correct line of code.
+  
Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expression` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code.
 
 Args:
   debuggeeId: string, Identifies the debuggee being debugged. (required)
@@ -231,127 +237,131 @@ 

Method Details

body: object, The request body. (required) The object takes the form of: -{ # The request to update an active breakpoint. - "breakpoint": { # Represents the breakpoint specification, status and results. # The updated breakpoint information. The field 'id' must be set. - "userEmail": "A String", # The e-mail of the user that created this breakpoint - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ... +{ # Request to update an active breakpoint. + "breakpoint": { # Represents the breakpoint specification, status and results. # Updated breakpoint information. The field 'id' must be set. + "userEmail": "A String", # E-mail address of the user that created this breakpoint + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ]. - "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`. + "variableTable": [ # 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. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], - "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG". - "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution. - "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution. + "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`. + "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution. + "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution. "stackFrames": [ # The stack at breakpoint time. { # Represents a stack frame context. - "function": "A String", # The unmangled function name at the call site. - "location": { # Represents a location in the source code. # The source location of the call site. - "path": "A String", # A path to the source file within the source context of the target binary. - "line": 42, # The line inside the file (first line value is '1'). + "function": "A String", # Demangled function name at the call site. + "location": { # Represents a location in the source code. # Source location of the call site. + "path": "A String", # Path to the source file within the source context of the target binary. + "line": 42, # Line inside the file. The first line in the file has the value `1`. }, - "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. - }, - ], - "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. # Object with schema name: Variable ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. + }, + ], + "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], }, ], - "location": { # Represents a location in the source code. # The breakpoint source location. - "path": "A String", # A path to the source file within the source context of the target binary. - "line": 42, # The line inside the file (first line value is '1'). + "location": { # Represents a location in the source code. # Breakpoint source location. + "path": "A String", # Path to the source file within the source context of the target binary. + "line": 42, # Line inside the file. The first line in the file has the value `1`. }, - "action": "A String", # Defines what to do when the breakpoint hits. - "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements. + "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit. + "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements. "A String", ], "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on. - "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee. - "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. + "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. }, } @@ -360,7 +370,7 @@

Method Details

Returns: An object of the form: - { # The response of updating an active breakpoint. The message is defined to allow future extensions. + { # Response for updating an active breakpoint. The message is defined to allow future extensions. }
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.html b/docs/dyn/clouddebugger_v2.controller.debuggees.html index a7e0fb1a8dc..6f30663a4dc 100644 --- a/docs/dyn/clouddebugger_v2.controller.debuggees.html +++ b/docs/dyn/clouddebugger_v2.controller.debuggees.html @@ -81,36 +81,36 @@

Instance Methods

register(body, x__xgafv=None)

-

Registers the debuggee with the controller. All agents should call this API with the same request content to get back the same stable 'debuggee_id'. Agents should call this API again whenever ListActiveBreakpoints or UpdateActiveBreakpoint return the error google.rpc.Code.NOT_FOUND. It allows the server to disable the agent or recover from any registration loss. If the debuggee is disabled server, the response will have is_disabled' set to true.

+

Registers the debuggee with the controller service. All agents attached to the same application should call this method with the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.

Method Details

register(body, x__xgafv=None) -
Registers the debuggee with the controller. All agents should call this API with the same request content to get back the same stable 'debuggee_id'. Agents should call this API again whenever ListActiveBreakpoints or UpdateActiveBreakpoint return the error google.rpc.Code.NOT_FOUND. It allows the server to disable the agent or recover from any registration loss. If the debuggee is disabled server, the response will have is_disabled' set to true.
+  
Registers the debuggee with the controller service. All agents attached to the same application should call this method with the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This allows the controller service to disable the agent or recover from any data loss. If the debuggee is disabled by the server, the response will have `is_disabled` set to `true`.
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # The request to register a debuggee.
-    "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same fields' values when registering. # The debuggee information to register. The fields 'project', 'uniquifier', 'description' and 'agent_version' of the debuggee must be set.
-      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Human readable message to be displayed to the user about this debuggee. Absense of this field indicates no message. The message can be either informational or error.
+{ # Request to register a debuggee.
+    "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering. # Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set.
+      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
         "isError": True or False, # Distinguishes errors from informational messages.
         "refersTo": "A String", # Reference to which the message applies.
         "description": { # Represents a message with parameters. # Status message text.
           "parameters": [ # Optional parameters to be embedded into the message.
             "A String",
           ],
-          "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
         },
       },
-      "description": "A String", # A human readable description of the debuggee. Recommended to include human readable project name, environment name, and version information .
-      "isDisabled": True or False, # If set to true, indicates that the agent should disable itself and detach from the debuggee.
+      "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
+      "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
       "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
         "a_key": "A String",
       },
-      "uniquifier": "A String", # The debuggee uniqifier within the project. Any string that id the application within the project can be used. Recomended to include environement and version or build id's.
-      "project": "A String", # The project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
-      "sourceContexts": [ # Repository snapshots containing the source code of the project.
+      "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
+      "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
+      "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
         { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
           "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
             "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
@@ -126,6 +126,10 @@ 

Method Details

}, }, "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision ID. "aliasName": "A String", # The name of an alias (branch, tag, etc.). "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. @@ -141,6 +145,10 @@

Method Details

"revisionId": "A String", # Git commit hash. required. }, "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision (commit) ID. "hostUri": "A String", # The URI of a running Gerrit instance. "aliasName": "A String", # The name of an alias (branch, tag, etc.). @@ -148,9 +156,60 @@

Method Details

}, }, ], - "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: "domain/type/vmajor.minor" (for example "google.com/gcp-java/v1.1"). - "isInactive": True or False, # If set to true indicates that the debuggee has not been seen by the Controller service in the last active time period (defined by the server). - "id": "A String", # Debuggee unique identifer generated by the server. + "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`. + { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context. + "labels": { # Labels with user defined metadata. + "a_key": "A String", + }, + "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context. + "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. + "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. + "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. + }, + }, + "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision ID. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + }, + "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). + "url": "A String", # Git repository URL. + "revisionId": "A String", # Git commit hash. required. + }, + "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision (commit) ID. + "hostUri": "A String", # The URI of a running Gerrit instance. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. + }, + }, + }, + ], + "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`). + "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service. + "id": "A String", # Unique identifier for the debuggee generated by the controller service. }, } @@ -159,26 +218,26 @@

Method Details

Returns: An object of the form: - { # The response of registering a debuggee. - "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same fields' values when registering. # The debuggee resource. The field 'id' is guranteed to be set (in addition to the echoed fields). - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Human readable message to be displayed to the user about this debuggee. Absense of this field indicates no message. The message can be either informational or error. + { # Response for registering a debuggee. + "debuggee": { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering. # Debuggee resource. The field `id` is guranteed to be set (in addition to the echoed fields). + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status. "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "description": "A String", # A human readable description of the debuggee. Recommended to include human readable project name, environment name, and version information . - "isDisabled": True or False, # If set to true, indicates that the agent should disable itself and detach from the debuggee. + "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. + "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee. "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user. "a_key": "A String", }, - "uniquifier": "A String", # The debuggee uniqifier within the project. Any string that id the application within the project can be used. Recomended to include environement and version or build id's. - "project": "A String", # The project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project. - "sourceContexts": [ # Repository snapshots containing the source code of the project. + "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended. + "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project. + "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`. { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. @@ -194,6 +253,10 @@

Method Details

}, }, "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision ID. "aliasName": "A String", # The name of an alias (branch, tag, etc.). "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. @@ -209,6 +272,10 @@

Method Details

"revisionId": "A String", # Git commit hash. required. }, "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision (commit) ID. "hostUri": "A String", # The URI of a running Gerrit instance. "aliasName": "A String", # The name of an alias (branch, tag, etc.). @@ -216,9 +283,60 @@

Method Details

}, }, ], - "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: "domain/type/vmajor.minor" (for example "google.com/gcp-java/v1.1"). - "isInactive": True or False, # If set to true indicates that the debuggee has not been seen by the Controller service in the last active time period (defined by the server). - "id": "A String", # Debuggee unique identifer generated by the server. + "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`. + { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context. + "labels": { # Labels with user defined metadata. + "a_key": "A String", + }, + "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context. + "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. + "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. + "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. + }, + }, + "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision ID. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + }, + "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). + "url": "A String", # Git repository URL. + "revisionId": "A String", # Git commit hash. required. + }, + "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision (commit) ID. + "hostUri": "A String", # The URI of a running Gerrit instance. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. + }, + }, + }, + ], + "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`). + "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service. + "id": "A String", # Unique identifier for the debuggee generated by the controller service. }, }
diff --git a/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html b/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html index fb261fbd7dd..266705b2080 100644 --- a/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html +++ b/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html @@ -82,7 +82,7 @@

Instance Methods

Gets breakpoint information.

list(debuggeeId, includeAllUsers=None, includeInactive=None, x__xgafv=None, stripResults=None, action_value=None, waitToken=None)

-

Lists all breakpoints of the debuggee that the user has access to.

+

Lists all breakpoints for the debuggee.

set(debuggeeId, body, x__xgafv=None)

Sets the breakpoint to the debuggee.

@@ -92,8 +92,8 @@

Method Details

Deletes the breakpoint from the debuggee.
 
 Args:
-  debuggeeId: string, The debuggee id to delete the breakpoint from. (required)
-  breakpointId: string, The breakpoint to delete. (required)
+  debuggeeId: string, ID of the debuggee whose breakpoint to delete. (required)
+  breakpointId: string, ID of the breakpoint to delete. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -108,277 +108,285 @@ 

Method Details

Gets breakpoint information.
 
 Args:
-  debuggeeId: string, The debuggee id to get the breakpoint from. (required)
-  breakpointId: string, The breakpoint to get. (required)
+  debuggeeId: string, ID of the debuggee whose breakpoint to get. (required)
+  breakpointId: string, ID of the breakpoint to get. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # The response of getting breakpoint information.
-    "breakpoint": { # Represents the breakpoint specification, status and results. # The complete breakpoint state. The fields 'id' and 'location' are guranteed to be set.
-      "userEmail": "A String", # The e-mail of the user that created this breakpoint
-      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ...
+    { # Response for getting breakpoint information.
+    "breakpoint": { # Represents the breakpoint specification, status and results. # Complete breakpoint state. The fields `id` and `location` are guaranteed to be set.
+      "userEmail": "A String", # E-mail address of the user that created this breakpoint
+      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
         "isError": True or False, # Distinguishes errors from informational messages.
         "refersTo": "A String", # Reference to which the message applies.
         "description": { # Represents a message with parameters. # Status message text.
           "parameters": [ # Optional parameters to be embedded into the message.
             "A String",
           ],
-          "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
         },
       },
-      "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ].
-      "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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.
-        { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-            # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-          "members": [ # The members contained or pointed to by the variable.
-            # Object with schema name: Variable
-          ],
-          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+      "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
+      "variableTable": [ # 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.
+        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
             "isError": True or False, # Distinguishes errors from informational messages.
             "refersTo": "A String", # Reference to which the message applies.
             "description": { # Represents a message with parameters. # Status message text.
               "parameters": [ # Optional parameters to be embedded into the message.
                 "A String",
               ],
-              "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
             },
           },
-          "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-          "name": "A String", # The name of the variable, if any.
-          "value": "A String", # The simple value of the variable.
+          "name": "A String", # Name of the variable, if any.
+          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+          "value": "A String", # Simple value of the variable.
+          "members": [ # Members contained or pointed to by the variable.
+            # Object with schema name: Variable
+          ],
+          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
         },
       ],
-      "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG".
-      "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution.
-      "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution.
+      "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
+      "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
+      "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
       "stackFrames": [ # The stack at breakpoint time.
         { # Represents a stack frame context.
-          "function": "A String", # The unmangled function name at the call site.
-          "location": { # Represents a location in the source code. # The source location of the call site.
-            "path": "A String", # A path to the source file within the source context of the target binary.
-            "line": 42, # The line inside the file (first line value is '1').
+          "function": "A String", # Demangled function name at the call site.
+          "location": { # Represents a location in the source code. # Source location of the call site.
+            "path": "A String", # Path to the source file within the source context of the target binary.
+            "line": 42, # Line inside the file. The first line in the file has the value `1`.
           },
-          "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
-            { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-              "members": [ # The members contained or pointed to by the variable.
-                # Object with schema name: Variable
-              ],
-              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+          "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
+            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                 "isError": True or False, # Distinguishes errors from informational messages.
                 "refersTo": "A String", # Reference to which the message applies.
                 "description": { # Represents a message with parameters. # Status message text.
                   "parameters": [ # Optional parameters to be embedded into the message.
                     "A String",
                   ],
-                  "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                 },
               },
-              "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-              "name": "A String", # The name of the variable, if any.
-              "value": "A String", # The simple value of the variable.
-            },
-          ],
-          "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames.
-            { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-              "members": [ # The members contained or pointed to by the variable.
+              "name": "A String", # Name of the variable, if any.
+              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+              "value": "A String", # Simple value of the variable.
+              "members": [ # Members contained or pointed to by the variable.
                 # Object with schema name: Variable
               ],
-              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
+            },
+          ],
+          "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
+            { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+              "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                 "isError": True or False, # Distinguishes errors from informational messages.
                 "refersTo": "A String", # Reference to which the message applies.
                 "description": { # Represents a message with parameters. # Status message text.
                   "parameters": [ # Optional parameters to be embedded into the message.
                     "A String",
                   ],
-                  "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                  "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                 },
               },
-              "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-              "name": "A String", # The name of the variable, if any.
-              "value": "A String", # The simple value of the variable.
+              "name": "A String", # Name of the variable, if any.
+              "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+              "value": "A String", # Simple value of the variable.
+              "members": [ # Members contained or pointed to by the variable.
+                # Object with schema name: Variable
+              ],
+              "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
             },
           ],
         },
       ],
-      "location": { # Represents a location in the source code. # The breakpoint source location.
-        "path": "A String", # A path to the source file within the source context of the target binary.
-        "line": 42, # The line inside the file (first line value is '1').
+      "location": { # Represents a location in the source code. # Breakpoint source location.
+        "path": "A String", # Path to the source file within the source context of the target binary.
+        "line": 42, # Line inside the file. The first line in the file has the value `1`.
       },
-      "action": "A String", # Defines what to do when the breakpoint hits.
-      "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements.
+      "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
+      "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
         "A String",
       ],
       "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
-      "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.
-        { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-            # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-          "members": [ # The members contained or pointed to by the variable.
-            # Object with schema name: Variable
-          ],
-          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+      "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
+        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
             "isError": True or False, # Distinguishes errors from informational messages.
             "refersTo": "A String", # Reference to which the message applies.
             "description": { # Represents a message with parameters. # Status message text.
               "parameters": [ # Optional parameters to be embedded into the message.
                 "A String",
               ],
-              "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
             },
           },
-          "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-          "name": "A String", # The name of the variable, if any.
-          "value": "A String", # The simple value of the variable.
+          "name": "A String", # Name of the variable, if any.
+          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+          "value": "A String", # Simple value of the variable.
+          "members": [ # Members contained or pointed to by the variable.
+            # Object with schema name: Variable
+          ],
+          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
         },
       ],
       "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
-      "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
+      "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
     },
   }
list(debuggeeId, includeAllUsers=None, includeInactive=None, x__xgafv=None, stripResults=None, action_value=None, waitToken=None) -
Lists all breakpoints of the debuggee that the user has access to.
+  
Lists all breakpoints for the debuggee.
 
 Args:
-  debuggeeId: string, The debuggee id to list breakpoint from. (required)
-  includeAllUsers: boolean, When set to true the response includes the list of breakpoints set by any user, otherwise only breakpoints set by the caller.
-  includeInactive: boolean, When set to true the response includes active and inactive breakpoints, otherwise only active breakpoints are returned.
+  debuggeeId: string, ID of the debuggee whose breakpoints to list. (required)
+  includeAllUsers: boolean, When set to `true`, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller.
+  includeInactive: boolean, When set to `true`, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints.
   x__xgafv: string, V1 error format.
-  stripResults: boolean, When set to true the response breakpoints will be stripped of the results fields: stack_frames, evaluated_expressions and variable_table.
+  stripResults: boolean, When set to `true`, the response breakpoints are stripped of the results fields: `stack_frames`, `evaluated_expressions` and `variable_table`.
   action_value: string, Only breakpoints with the specified action will pass the filter.
-  waitToken: string, 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 to ListBreakpoints. The error code ABORTED is returned on wait timeout, which should be called again with the same wait_token.
+  waitToken: string, 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`.
 
 Returns:
   An object of the form:
 
-    { # The response of listing breakpoints.
-    "nextWaitToken": "A String", # A wait token that can be used in the next call to ListBreakpoints to block until the list of breakpoints has changes.
-    "breakpoints": [ # List of all breakpoints with complete state. The fields 'id' and 'location' are guranteed to be set on each breakpoint.
+    { # Response for listing breakpoints.
+    "nextWaitToken": "A String", # A wait token that can be used in the next call to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakpoints has changes.
+    "breakpoints": [ # List of all breakpoints with complete state. The fields `id` and `location` are guaranteed to be set on each breakpoint.
       { # Represents the breakpoint specification, status and results.
-        "userEmail": "A String", # The e-mail of the user that created this breakpoint
-        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ...
+        "userEmail": "A String", # E-mail address of the user that created this breakpoint
+        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
           "isError": True or False, # Distinguishes errors from informational messages.
           "refersTo": "A String", # Reference to which the message applies.
           "description": { # Represents a message with parameters. # Status message text.
             "parameters": [ # Optional parameters to be embedded into the message.
               "A String",
             ],
-            "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
           },
         },
-        "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ].
-        "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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.
-          { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-              # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-            "members": [ # The members contained or pointed to by the variable.
-              # Object with schema name: Variable
-            ],
-            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+        "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
+        "variableTable": [ # 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.
+          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
               "isError": True or False, # Distinguishes errors from informational messages.
               "refersTo": "A String", # Reference to which the message applies.
               "description": { # Represents a message with parameters. # Status message text.
                 "parameters": [ # Optional parameters to be embedded into the message.
                   "A String",
                 ],
-                "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
               },
             },
-            "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-            "name": "A String", # The name of the variable, if any.
-            "value": "A String", # The simple value of the variable.
+            "name": "A String", # Name of the variable, if any.
+            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+            "value": "A String", # Simple value of the variable.
+            "members": [ # Members contained or pointed to by the variable.
+              # Object with schema name: Variable
+            ],
+            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
           },
         ],
-        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG".
-        "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution.
-        "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution.
+        "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
+        "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
+        "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
         "stackFrames": [ # The stack at breakpoint time.
           { # Represents a stack frame context.
-            "function": "A String", # The unmangled function name at the call site.
-            "location": { # Represents a location in the source code. # The source location of the call site.
-              "path": "A String", # A path to the source file within the source context of the target binary.
-              "line": 42, # The line inside the file (first line value is '1').
+            "function": "A String", # Demangled function name at the call site.
+            "location": { # Represents a location in the source code. # Source location of the call site.
+              "path": "A String", # Path to the source file within the source context of the target binary.
+              "line": 42, # Line inside the file. The first line in the file has the value `1`.
             },
-            "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
-              { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                  # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-                "members": [ # The members contained or pointed to by the variable.
-                  # Object with schema name: Variable
-                ],
-                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+            "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
+              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                   "isError": True or False, # Distinguishes errors from informational messages.
                   "refersTo": "A String", # Reference to which the message applies.
                   "description": { # Represents a message with parameters. # Status message text.
                     "parameters": [ # Optional parameters to be embedded into the message.
                       "A String",
                     ],
-                    "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                   },
                 },
-                "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-                "name": "A String", # The name of the variable, if any.
-                "value": "A String", # The simple value of the variable.
-              },
-            ],
-            "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames.
-              { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-                  # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-                "members": [ # The members contained or pointed to by the variable.
+                "name": "A String", # Name of the variable, if any.
+                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+                "value": "A String", # Simple value of the variable.
+                "members": [ # Members contained or pointed to by the variable.
                   # Object with schema name: Variable
                 ],
-                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
+              },
+            ],
+            "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
+              { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+                  # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+                "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
                   "isError": True or False, # Distinguishes errors from informational messages.
                   "refersTo": "A String", # Reference to which the message applies.
                   "description": { # Represents a message with parameters. # Status message text.
                     "parameters": [ # Optional parameters to be embedded into the message.
                       "A String",
                     ],
-                    "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                    "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
                   },
                 },
-                "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-                "name": "A String", # The name of the variable, if any.
-                "value": "A String", # The simple value of the variable.
+                "name": "A String", # Name of the variable, if any.
+                "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+                "value": "A String", # Simple value of the variable.
+                "members": [ # Members contained or pointed to by the variable.
+                  # Object with schema name: Variable
+                ],
+                "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
               },
             ],
           },
         ],
-        "location": { # Represents a location in the source code. # The breakpoint source location.
-          "path": "A String", # A path to the source file within the source context of the target binary.
-          "line": 42, # The line inside the file (first line value is '1').
+        "location": { # Represents a location in the source code. # Breakpoint source location.
+          "path": "A String", # Path to the source file within the source context of the target binary.
+          "line": 42, # Line inside the file. The first line in the file has the value `1`.
         },
-        "action": "A String", # Defines what to do when the breakpoint hits.
-        "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements.
+        "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
+        "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
           "A String",
         ],
         "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
-        "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.
-          { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-              # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-            "members": [ # The members contained or pointed to by the variable.
-              # Object with schema name: Variable
-            ],
-            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+        "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
+          { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+              # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+            "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
               "isError": True or False, # Distinguishes errors from informational messages.
               "refersTo": "A String", # Reference to which the message applies.
               "description": { # Represents a message with parameters. # Status message text.
                 "parameters": [ # Optional parameters to be embedded into the message.
                   "A String",
                 ],
-                "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+                "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
               },
             },
-            "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-            "name": "A String", # The name of the variable, if any.
-            "value": "A String", # The simple value of the variable.
+            "name": "A String", # Name of the variable, if any.
+            "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+            "value": "A String", # Simple value of the variable.
+            "members": [ # Members contained or pointed to by the variable.
+              # Object with schema name: Variable
+            ],
+            "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
           },
         ],
         "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
-        "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
+        "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
       },
     ],
   }
@@ -389,130 +397,134 @@

Method Details

Sets the breakpoint to the debuggee.
 
 Args:
-  debuggeeId: string, The debuggee id to set the breakpoint to. (required)
+  debuggeeId: string, ID of the debuggee where the breakpoint is to be set. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Represents the breakpoint specification, status and results.
-  "userEmail": "A String", # The e-mail of the user that created this breakpoint
-  "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ...
+  "userEmail": "A String", # E-mail address of the user that created this breakpoint
+  "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition
     "isError": True or False, # Distinguishes errors from informational messages.
     "refersTo": "A String", # Reference to which the message applies.
     "description": { # Represents a message with parameters. # Status message text.
       "parameters": [ # Optional parameters to be embedded into the message.
         "A String",
       ],
-      "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+      "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
     },
   },
-  "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ].
-  "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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.
-    { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-        # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-      "members": [ # The members contained or pointed to by the variable.
-        # Object with schema name: Variable
-      ],
-      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+  "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`.
+  "variableTable": [ # 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.
+    { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+        # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
         "isError": True or False, # Distinguishes errors from informational messages.
         "refersTo": "A String", # Reference to which the message applies.
         "description": { # Represents a message with parameters. # Status message text.
           "parameters": [ # Optional parameters to be embedded into the message.
             "A String",
           ],
-          "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
         },
       },
-      "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-      "name": "A String", # The name of the variable, if any.
-      "value": "A String", # The simple value of the variable.
+      "name": "A String", # Name of the variable, if any.
+      "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+      "value": "A String", # Simple value of the variable.
+      "members": [ # Members contained or pointed to by the variable.
+        # Object with schema name: Variable
+      ],
+      "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
     },
   ],
-  "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG".
-  "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution.
-  "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution.
+  "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
+  "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution.
+  "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
   "stackFrames": [ # The stack at breakpoint time.
     { # Represents a stack frame context.
-      "function": "A String", # The unmangled function name at the call site.
-      "location": { # Represents a location in the source code. # The source location of the call site.
-        "path": "A String", # A path to the source file within the source context of the target binary.
-        "line": 42, # The line inside the file (first line value is '1').
+      "function": "A String", # Demangled function name at the call site.
+      "location": { # Represents a location in the source code. # Source location of the call site.
+        "path": "A String", # Path to the source file within the source context of the target binary.
+        "line": 42, # Line inside the file. The first line in the file has the value `1`.
       },
-      "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
-        { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-            # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-          "members": [ # The members contained or pointed to by the variable.
-            # Object with schema name: Variable
-          ],
-          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+      "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames.
+        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
             "isError": True or False, # Distinguishes errors from informational messages.
             "refersTo": "A String", # Reference to which the message applies.
             "description": { # Represents a message with parameters. # Status message text.
               "parameters": [ # Optional parameters to be embedded into the message.
                 "A String",
               ],
-              "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
             },
           },
-          "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-          "name": "A String", # The name of the variable, if any.
-          "value": "A String", # The simple value of the variable.
-        },
-      ],
-      "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames.
-        { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-            # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-          "members": [ # The members contained or pointed to by the variable.
+          "name": "A String", # Name of the variable, if any.
+          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+          "value": "A String", # Simple value of the variable.
+          "members": [ # Members contained or pointed to by the variable.
             # Object with schema name: Variable
           ],
-          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
+        },
+      ],
+      "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames.
+        { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+            # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+          "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
             "isError": True or False, # Distinguishes errors from informational messages.
             "refersTo": "A String", # Reference to which the message applies.
             "description": { # Represents a message with parameters. # Status message text.
               "parameters": [ # Optional parameters to be embedded into the message.
                 "A String",
               ],
-              "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+              "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
             },
           },
-          "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-          "name": "A String", # The name of the variable, if any.
-          "value": "A String", # The simple value of the variable.
+          "name": "A String", # Name of the variable, if any.
+          "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+          "value": "A String", # Simple value of the variable.
+          "members": [ # Members contained or pointed to by the variable.
+            # Object with schema name: Variable
+          ],
+          "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
         },
       ],
     },
   ],
-  "location": { # Represents a location in the source code. # The breakpoint source location.
-    "path": "A String", # A path to the source file within the source context of the target binary.
-    "line": 42, # The line inside the file (first line value is '1').
+  "location": { # Represents a location in the source code. # Breakpoint source location.
+    "path": "A String", # Path to the source file within the source context of the target binary.
+    "line": 42, # Line inside the file. The first line in the file has the value `1`.
   },
-  "action": "A String", # Defines what to do when the breakpoint hits.
-  "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements.
+  "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit.
+  "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements.
     "A String",
   ],
   "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on.
-  "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field.
-    { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , ,
-        # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references.
-      "members": [ # The members contained or pointed to by the variable.
-        # Object with schema name: Variable
-      ],
-      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference".
+  "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text.
+    { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, `
+        # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it.
+      "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference`
         "isError": True or False, # Distinguishes errors from informational messages.
         "refersTo": "A String", # Reference to which the message applies.
         "description": { # Represents a message with parameters. # Status message text.
           "parameters": [ # Optional parameters to be embedded into the message.
             "A String",
           ],
-          "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+          "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
         },
       },
-      "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint.
-      "name": "A String", # The name of the variable, if any.
-      "value": "A String", # The simple value of the variable.
+      "name": "A String", # Name of the variable, if any.
+      "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint.
+      "value": "A String", # Simple value of the variable.
+      "members": [ # Members contained or pointed to by the variable.
+        # Object with schema name: Variable
+      ],
+      "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object.
     },
   ],
   "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee.
-  "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
+  "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location.
 }
 
   x__xgafv: string, V1 error format.
@@ -520,127 +532,131 @@ 

Method Details

Returns: An object of the form: - { # The response of setting a breakpoint. - "breakpoint": { # Represents the breakpoint specification, status and results. # The breakpoint resource. The field 'id' is guranteed to be set (in addition to the echoed fileds). - "userEmail": "A String", # The e-mail of the user that created this breakpoint - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Breakpoint status. The status includes an error flag and a human readable message. This field will usually stay unset. The message can be either informational or error. Nevertheless, clients should always display the text message back to the user. Error status of a breakpoint indicates complete failure. Example (non-final state): 'Still loading symbols...' Examples (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field f not found in class C' referring to condition, ... + { # Response for setting a breakpoint. + "breakpoint": { # Represents the breakpoint specification, status and results. # Breakpoint resource. The field `id` is guaranteed to be set (in addition to the echoed fileds). + "userEmail": "A String", # E-mail address of the user that created this breakpoint + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "logMessageFormat": "A String", # Only relevant when action is "LOG". Defines the message to log when the breakpoint hits. The message may include parameter placeholders "$0", "$1", etc. These placeholders will be replaced with the evaluated value of the appropriate expression. Expressions not referenced in "log_message_format" will not be logged. Example: "Poisonous message received, id = $0, count = $1" with expressions = [ "message.id", "message.count" ]. - "variableTable": [ # 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 object 'this', which may appear at many levels of the stack, can have all of it's data stored once in this table. The stack frame variables then would hold only a reference to it. The variable var_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. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`. + "variableTable": [ # 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. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], - "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is "LOG". - "finalTime": "A String", # The time this breakpoint was finalized as seen by the server. The value is in seconds resolution. - "createTime": "A String", # The time this breakpoint was created by the server. The value is in seconds resolution. + "logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`. + "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds resolution. + "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution. "stackFrames": [ # The stack at breakpoint time. { # Represents a stack frame context. - "function": "A String", # The unmangled function name at the call site. - "location": { # Represents a location in the source code. # The source location of the call site. - "path": "A String", # A path to the source file within the source context of the target binary. - "line": 42, # The line inside the file (first line value is '1'). + "function": "A String", # Demangled function name at the call site. + "location": { # Represents a location in the source code. # Source location of the call site. + "path": "A String", # Path to the source file within the source context of the target binary. + "line": 42, # Line inside the file. The first line in the file has the value `1`. }, - "locals": [ # The set of local variables at the stack frame location. Note that this might not be populated for all stack frames. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "locals": [ # Set of local variables at the stack frame location. Note that this might not be populated for all stack frames. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. - }, - ], - "arguments": [ # The set of arguments passed to this function Note that this might not be populated for all stack frames. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. # Object with schema name: Variable ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. + }, + ], + "arguments": [ # Set of arguments passed to this function. Note that this might not be populated for all stack frames. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], }, ], - "location": { # Represents a location in the source code. # The breakpoint source location. - "path": "A String", # A path to the source file within the source context of the target binary. - "line": 42, # The line inside the file (first line value is '1'). + "location": { # Represents a location in the source code. # Breakpoint source location. + "path": "A String", # Path to the source file within the source context of the target binary. + "line": 42, # Line inside the file. The first line in the file has the value `1`. }, - "action": "A String", # Defines what to do when the breakpoint hits. - "expressions": [ # A list of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is "LOG", the evaluated expressions are included in log statements. + "action": "A String", # Action that the agent should perform when the code at the breakpoint location is hit. + "expressions": [ # List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements. "A String", ], "isFinalState": True or False, # When true, indicates that this is a final result and the breakpoint state will not change from here on. - "evaluatedExpressions": [ # The evaluated expressions' values at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the 'expressions' field. The 'name' field holds the original expression text, the 'value'/'members' field holds the result of the evaluated expression. If the expression can not be evaluated, an error text is placed in the value field. - { # Represents a variable or an argument possibly of a compound object type. 1. A simple variable such as, int x = 5 is represented as: { name: "x", value: "5" } 2. A compound object such as, struct T { int m1; int m2; }; T x = { 3, 7 }; is represented as: { name: "x", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 3. A pointer where the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as: { name: "p", value: "0x00500500", members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } 4. A pointer where the pointee was not captured or is inaccessible such as, T* p = new T; is represented as: { name: "p", value: "0x00400400", members { value: "" } } the value text should decribe the reason for the missing value. such as , , - # . note that a null pointer should not have members. 5. An unnamed value such as, int* p = new int(7); is represented as, { name: "p", value: "0x00500500", members { value: "7" } } 6. An unnamed pointer where the pointee was not captured such as, int* p = new int(7); int** pp = &p; is represented as: { name: "pp", value: "0x00500500", members { value: "0x00400400", members { value: "" } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the var_index field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable merge the referencing variable with the referenced variable. When using the shared variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T& r = x; are represented as, { name: "x", var_index: 3 } { name: "p", value "0x00500500", var_index: 3 } { name: "r", var_index: 3 } with shared variable table entry #3: { members { name: "m1", value: "3" }, members { name: "m2", value: "7" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable, to allow the referenced variable to be shared between pointer and references. - "members": [ # The members contained or pointed to by the variable. - # Object with schema name: Variable - ], - "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with "refers_to" set to "VARIABLE_NAME". Alternatively "refers_to" will be set to "VARIABLE_VALUE". In either case variable value and members will be unset. Example of error message applied to name: "Invalid expression syntax". Example of information message applied to value: "Not captured". Examples of error message applied to value: "Malformed string", "Field f not found in class C", "Null pointer dereference". + "evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text. + { # Represents a variable or an argument possibly of a compound object type. Note how the following variables are represented: 1) A simple variable: int x = 5 { name: "x", value: "5", type: "int" } // Captured variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { // Captured variable name: "x", type: "T", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 3) A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captured variable name: "p", type: "T*", value: "0x00500500", members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } 4) A pointer where the pointee was not captured: T* p = new T; { // Captured variable name: "p", type: "T*", value: "0x00400400" status { is_error: true, description { format: "unavailable" } } } The status should describe the reason for the missing value, such as ``, ``, ` + # `. Note that a null pointer should not have members. 5) An unnamed value: int* p = new int(7); { // Captured variable name: "p", value: "0x00500500", type: "int*", members { value: "7", type: "int" } } 6) An unnamed pointer where the pointee was not captured: int* p = new int(7); int** pp = &p; { // Captured variable name: "pp", value: "0x00500500", type: "int**", members { value: "0x00400400", type: "int*" status { is_error: true, description: { format: "unavailable" } } } } } To optimize computation, memory and network traffic, variables that repeat in the output multiple times can be stored once in a shared variable table and be referenced using the `var_table_index` field. The variables stored in the shared table are nameless and are essentially a partition of the complete variable. To reconstruct the complete variable, merge the referencing variable with the referenced variable. When using the shared variable table, the following variables: T x = { 3, 7 }; T* p = &x; T& r = x; { name: "x", var_table_index: 3, type: "T" } // Captured variables { name: "p", value "0x00500500", type="T*", var_table_index: 3 } { name: "r", type="T&", var_table_index: 3 } { // Shared variable table entry #3: members { name: "m1", value: "3", type: "int" }, members { name: "m2", value: "7", type: "int" } } Note that the pointer address is stored with the referencing variable and not with the referenced variable. This allows the referenced variable to be shared between pointers and references. The type field is optional. The debugger agent may or may not support it. + "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state. The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variable value and members will be unset. Example of error message applied to name: `Invalid expression syntax`. Example of information message applied to value: `Not captured`. Examples of error message applied to value: * `Malformed string`, * `Field f not found in class C` * `Null pointer dereference` "isError": True or False, # Distinguishes errors from informational messages. "refersTo": "A String", # Reference to which the message applies. "description": { # Represents a message with parameters. # Status message text. "parameters": [ # Optional parameters to be embedded into the message. "A String", ], - "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1." + "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.` }, }, - "varTableIndex": 42, # This is a reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The var_index field is an index into variable_table in Breakpoint. - "name": "A String", # The name of the variable, if any. - "value": "A String", # The simple value of the variable. + "name": "A String", # Name of the variable, if any. + "varTableIndex": 42, # Reference to a variable in the shared variable table. More than one variable can reference the same variable in the table. The `var_table_index` field is an index into `variable_table` in Breakpoint. + "value": "A String", # Simple value of the variable. + "members": [ # Members contained or pointed to by the variable. + # Object with schema name: Variable + ], + "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with `var_table_index`, `type` goes next to `value`. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. }, ], "id": "A String", # Breakpoint identifier, unique in the scope of the debuggee. - "condition": "A String", # A condition to trigger the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. + "condition": "A String", # Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. }, }
diff --git a/docs/dyn/clouddebugger_v2.debugger.debuggees.html b/docs/dyn/clouddebugger_v2.debugger.debuggees.html index 07bd27eb1fc..950273682fd 100644 --- a/docs/dyn/clouddebugger_v2.debugger.debuggees.html +++ b/docs/dyn/clouddebugger_v2.debugger.debuggees.html @@ -88,34 +88,34 @@

Method Details

Lists all the debuggees that the user can set breakpoints to.
 
 Args:
-  includeInactive: boolean, When set to true the result includes all debuggees, otherwise only debugees that are active.
-  project: string, Set to the project number of the Google Cloud Platform to list the debuggees that are part of that project.
+  includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
+  project: string, Project number of a Google Cloud project whose debuggees to list.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # The response of listing debuggees.
-    "debuggees": [ # The list of debuggees accessible to the calling user. Note that the description field is the only human readable field that should be displayed to the user. The fields 'debuggee.id' and 'description' are guranteed to be set on each debuggee.
-      { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same fields' values when registering.
-        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the Breakpoint.status field can indicate an error referring to the BREAKPOINT_SOURCE_LOCATION with the message "Location not found". # Human readable message to be displayed to the user about this debuggee. Absense of this field indicates no message. The message can be either informational or error.
+    { # Response for listing debuggees.
+    "debuggees": [ # List of debuggees accessible to the calling user. Note that the `description` field is the only human readable field that should be displayed to the user. The fields `debuggee.id` and `description` fields are guaranteed to be set on each debuggee.
+      { # Represents the application to debug. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. The agents attached to the same debuggee are identified by using exactly the same field values when registering.
+        "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status.
           "isError": True or False, # Distinguishes errors from informational messages.
           "refersTo": "A String", # Reference to which the message applies.
           "description": { # Represents a message with parameters. # Status message text.
             "parameters": [ # Optional parameters to be embedded into the message.
               "A String",
             ],
-            "format": "A String", # Format template of the message. The "format" uses placeholders "$0", "$1", etc. to reference parameters. "$$" can be used to denote the '$' character. Examples: "Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important." "Please pay $$10 to use $0 instead of $1."
+            "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to denote the `$` character. Examples: * `Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
           },
         },
-        "description": "A String", # A human readable description of the debuggee. Recommended to include human readable project name, environment name, and version information .
-        "isDisabled": True or False, # If set to true, indicates that the agent should disable itself and detach from the debuggee.
+        "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
+        "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
         "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
           "a_key": "A String",
         },
-        "uniquifier": "A String", # The debuggee uniqifier within the project. Any string that id the application within the project can be used. Recomended to include environement and version or build id's.
-        "project": "A String", # The project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
-        "sourceContexts": [ # Repository snapshots containing the source code of the project.
+        "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
+        "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
+        "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
           { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
             "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
               "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
@@ -131,6 +131,10 @@ 

Method Details

}, }, "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision ID. "aliasName": "A String", # The name of an alias (branch, tag, etc.). "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. @@ -146,6 +150,10 @@

Method Details

"revisionId": "A String", # Git commit hash. required. }, "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, "revisionId": "A String", # A revision (commit) ID. "hostUri": "A String", # The URI of a running Gerrit instance. "aliasName": "A String", # The name of an alias (branch, tag, etc.). @@ -153,9 +161,60 @@

Method Details

}, }, ], - "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: "domain/type/vmajor.minor" (for example "google.com/gcp-java/v1.1"). - "isInactive": True or False, # If set to true indicates that the debuggee has not been seen by the Controller service in the last active time period (defined by the server). - "id": "A String", # Debuggee unique identifer generated by the server. + "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`. + { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context. + "labels": { # Labels with user defined metadata. + "a_key": "A String", + }, + "context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # Any source context. + "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. + "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. + "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. + }, + }, + "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision ID. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. + "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. + "projectId": "A String", # The ID of the project. + "repoName": "A String", # The name of the repo. Leave empty for the default repo. + }, + "uid": "A String", # A server-assigned, globally unique identifier. + }, + }, + "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). + "url": "A String", # Git repository URL. + "revisionId": "A String", # Git commit hash. required. + }, + "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. + "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. + "kind": "A String", # The alias kind. + "name": "A String", # The alias name. + }, + "revisionId": "A String", # A revision (commit) ID. + "hostUri": "A String", # The URI of a running Gerrit instance. + "aliasName": "A String", # The name of an alias (branch, tag, etc.). + "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. + }, + }, + }, + ], + "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`). + "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service. + "id": "A String", # Unique identifier for the debuggee generated by the controller service. }, ], }
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html index 294e4dc94b0..86681d7c67f 100644 --- a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html +++ b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html @@ -76,29 +76,29 @@

Google Cloud Resource Manager AP

Instance Methods

get(organizationId, x__xgafv=None)

-

Fetches an Organization resource by id.

+

Fetches an Organization resource identified by the specified `organization_id`.

getIamPolicy(resource, body, x__xgafv=None)

-

Gets the access control policy for a Organization resource. May be empty if no such policy or resource exists.

+

Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists.

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

-

Query Organization resources.

+

Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

-

Sets the access control policy on a Organization resource. Replaces any existing policy.

+

Sets the access control policy on an Organization resource. Replaces any existing policy.

testIamPermissions(resource, body, x__xgafv=None)

Returns permissions that a caller has on the specified Organization.

update(organizationId, body, x__xgafv=None)

-

Updates an Organization resource.

+

Updates an Organization resource identified by the specified `organization_id`.

Method Details

get(organizationId, x__xgafv=None) -
Fetches an Organization resource by id.
+  
Fetches an Organization resource identified by the specified `organization_id`.
 
 Args:
   organizationId: string, The id of the Organization resource to fetch. (required)
@@ -109,19 +109,20 @@ 

Method Details

{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. - "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required. + "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API. }, "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required. + "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly }
getIamPolicy(resource, body, x__xgafv=None) -
Gets the access control policy for a Organization resource. May be empty if no such policy or resource exists.
+  
Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
@@ -133,42 +134,43 @@ 

Method Details

Returns: An object of the form: - { # 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]. + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) -
Query Organization resources.
+  
Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.
 
 Args:
   pageSize: integer, The maximum number of Organizations to return in the response. This field is optional.
-  filter: string, An optional query string used to filter the Organizations to be return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
-  pageToken: string, A pagination token returned from a previous call to ListOrganizations that indicates from where listing should continue. This field is optional.
+  filter: string, An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a Google for Work domain, for example: |Filter|Description| |------|-----------| |owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.| |domain:google.com|Organizations corresponding to the domain `google.com`.| This field is optional.
+  pageToken: string, A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # The response returned from the ListOrganizations method.
+    { # The response returned from the `ListOrganizations` method.
     "nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.
     "organizations": [ # The list of Organizations that matched the list query, possibly paginated.
       { # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.
         "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.
-        "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required.
+        "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
           "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API.
         },
         "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required.
+        "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly
       },
     ],
   }
@@ -190,25 +192,25 @@

Method Details

setIamPolicy(resource, body, x__xgafv=None) -
Sets the access control policy on a Organization resource. Replaces any existing policy.
+  
Sets the access control policy on an Organization resource. Replaces any existing policy.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `SetIamPolicy` method.
-    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` For a description of IAM and its features, see the [IAM developer's guide][https://cloud.google.com/iam]. # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+    "policy": { # 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). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
       "bindings": [ # 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.
         { # Associates `members` with a `role`.
           "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
-          "members": [ # 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`.
+          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
             "A String",
           ],
         },
       ],
       "version": 42, # Version of the `Policy`. The default version is 0.
-      "etag": "A String", # Can be used to perform a read-modify-write.
+      "etag": "A String", # `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.
     },
   }
 
@@ -217,17 +219,17 @@ 

Method Details

Returns: An object of the form: - { # 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]. + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
@@ -236,12 +238,12 @@

Method Details

Returns permissions that a caller has on the specified Organization.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `TestIamPermissions` method.
-    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
       "A String",
     ],
   }
@@ -260,7 +262,7 @@ 

Method Details

update(organizationId, body, x__xgafv=None) -
Updates an Organization resource.
+  
Updates an Organization resource identified by the specified `organization_id`.
 
 Args:
   organizationId: string, An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. (required)
@@ -269,10 +271,11 @@ 

Method Details

{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. - "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required. + "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API. }, "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required. + "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly } x__xgafv: string, V1 error format. @@ -282,10 +285,11 @@

Method Details

{ # The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong. "organizationId": "A String", # An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only. - "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified upon creation. Once set, it cannot be changed. This field is required. + "owner": { # The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted. # The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required. "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API. }, "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. This field is required. + "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. @OutputOnly }
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html index b447697d654..2cfa8ea61be 100644 --- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html @@ -76,55 +76,55 @@

Google Cloud Resource Manager AP

Instance Methods

create(body, x__xgafv=None)

-

Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.

+

Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.

delete(projectId, x__xgafv=None)

-

Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.

+

Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.

get(projectId, x__xgafv=None)

-

Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.

+

Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.

getIamPolicy(resource, body, x__xgafv=None)

-

Returns the IAM access control policy for specified project.

+

Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.

list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)

-

Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.

+

Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setIamPolicy(resource, body, x__xgafv=None)

-

Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.

+

Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project currently supports only `user:{emailid}` and `serviceAccount:{emailid}` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user must be invited via Cloud Platform console and must accept the invitation. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.

testIamPermissions(resource, body, x__xgafv=None)

-

Tests the specified permissions against the IAM access control policy for the specified project.

+

Returns permissions that a caller has on the specified Project.

undelete(projectId, x__xgafv=None)

-

Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.

+

Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The caller must have modify permissions for this Project.

update(projectId, body, x__xgafv=None)

-

Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.

+

Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.

Method Details

create(body, x__xgafv=None) -
Creates a project resource. Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project. Several APIs are activated automatically for the project, including Google Cloud Storage.
+  
Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage.
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
-  "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
-  "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
+  "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+  "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
     "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
     "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
   },
-  "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
-  "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+  "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
+  "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
     "a_key": "A String",
   },
   "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
-  "lifecycleState": "A String", # The project lifecycle state. Read-only.
+  "lifecycleState": "A String", # The Project lifecycle state. Read-only.
   "createTime": "A String", # Creation time. Read-only.
 }
 
@@ -134,27 +134,27 @@ 

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. - "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. - "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. + "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. + "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization". "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's. }, - "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. - "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. + "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. + "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", }, "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only. - "lifecycleState": "A String", # The project lifecycle state. Read-only. + "lifecycleState": "A String", # The Project lifecycle state. Read-only. "createTime": "A String", # Creation time. Read-only. }
delete(projectId, x__xgafv=None) -
Marks the project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the project if the following criteria are met: + The project does not have a billing account associated with it. + The project has a lifecycle state of [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.
+  
Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if the following criteria are met: + The Project does not have a billing account associated with it. + The Project has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have modify permissions for this Project.
 
 Args:
-  projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
+  projectId: string, The Project ID (for example, `foo-bar-123`). Required. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
@@ -166,37 +166,37 @@ 

Method Details

get(projectId, x__xgafv=None) -
Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.
+  
Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.
 
 Args:
-  projectId: string, The project ID (for example, `my-project-123`). Required. (required)
+  projectId: string, The Project ID (for example, `my-project-123`). Required. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
     { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
-    "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
-    "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
+    "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+    "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
       "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
       "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
     },
-    "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
-    "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+    "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
+    "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
       "a_key": "A String",
     },
     "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
-    "lifecycleState": "A String", # The project lifecycle state. Read-only.
+    "lifecycleState": "A String", # The Project lifecycle state. Read-only.
     "createTime": "A String", # Creation time. Read-only.
   }
getIamPolicy(resource, body, x__xgafv=None) -
Returns the IAM access control policy for specified project.
+  
Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
@@ -208,48 +208,48 @@ 

Method Details

Returns: An object of the form: - { # 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]. + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
list(pageSize=None, filter=None, pageToken=None, x__xgafv=None) -
Lists projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.
+  
Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.
 
 Args:
-  pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. Note: pagination is not yet supported; the server ignores this field. Optional.
+  pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.
   filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: + `name` + `id` + labels.key where *key* is the name of a label Some examples of using labels as filters: |Filter|Description| |------|-----------| |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.| |labels.color:*|The project has the label `color`.| |labels.color:red|The project's label `color` has the value `red`.| |labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
-  pageToken: string, A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.
+  pageToken: string, A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
-    "nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime. Note: pagination is not yet supported; the server will not set this field.
-    "projects": [ # The list of projects that matched the list filter. This list can be paginated.
+    { # A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
+    "nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.
+    "projects": [ # The list of Projects that matched the list filter. This list can be paginated.
       { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
-        "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
-        "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
+        "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write.
+        "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
           "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
           "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
         },
-        "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
-        "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
+        "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation.
+        "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
           "a_key": "A String",
         },
         "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
-        "lifecycleState": "A String", # The project lifecycle state. Read-only.
+        "lifecycleState": "A String", # The Project lifecycle state. Read-only.
         "createTime": "A String", # Creation time. Read-only.
       },
     ],
@@ -272,25 +272,25 @@ 

Method Details

setIamPolicy(resource, body, x__xgafv=None) -
Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.
+  
Sets the IAM access control policy for the specified Project. Replaces any existing policy. The following constraints apply when using `setIamPolicy()`: + Project currently supports only `user:{emailid}` and `serviceAccount:{emailid}` members in a `Binding` of a `Policy`. + To be added as an `owner`, a user must be invited via Cloud Platform console and must accept the invitation. + Members cannot be added to more than one role in the same policy. + There must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted owner from the policy will fail. + Calling this method requires enabling the App Engine Admin API. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `SetIamPolicy` method.
-    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` For a description of IAM and its features, see the [IAM developer's guide][https://cloud.google.com/iam]. # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+    "policy": { # 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). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
       "bindings": [ # 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.
         { # Associates `members` with a `role`.
           "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
-          "members": [ # 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`.
+          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
             "A String",
           ],
         },
       ],
       "version": 42, # Version of the `Policy`. The default version is 0.
-      "etag": "A String", # Can be used to perform a read-modify-write.
+      "etag": "A String", # `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.
     },
   }
 
@@ -299,31 +299,31 @@ 

Method Details

Returns: An object of the form: - { # 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]. + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
testIamPermissions(resource, body, x__xgafv=None) -
Tests the specified permissions against the IAM access control policy for the specified project.
+  
Returns permissions that a caller has on the specified Project.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`. (required)
+  resource: string, 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)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `TestIamPermissions` method.
-    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
       "A String",
     ],
   }
@@ -342,7 +342,7 @@ 

Method Details

undelete(projectId, x__xgafv=None) -
Restores the project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a project that has a lifecycle state of [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.
+  
Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the Project cannot be restored. The caller must have modify permissions for this Project.
 
 Args:
   projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
@@ -357,7 +357,7 @@ 

Method Details

update(projectId, body, x__xgafv=None) -
Updates the attributes of the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this project.
+  
Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.
 
 Args:
   projectId: string, The project ID (for example, `my-project-123`). Required. (required)
@@ -365,17 +365,17 @@ 

Method Details

The object takes the form of: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. - "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. - "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. + "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. + "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization". "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's. }, - "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. - "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. + "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. + "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", }, "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only. - "lifecycleState": "A String", # The project lifecycle state. Read-only. + "lifecycleState": "A String", # The Project lifecycle state. Read-only. "createTime": "A String", # Creation time. Read-only. } @@ -385,17 +385,17 @@

Method Details

An object of the form: { # A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources. - "name": "A String", # The user-assigned name of the project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. - "parent": { # A container to reference an id for any resource type. A 'resource' in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. + "name": "A String", # The user-assigned name of the Project. It must be 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Read-write. + "parent": { # A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an AppEngine app, a Compute Engine instance, a Cloud SQL database, and so on. # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write. "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization". "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's. }, - "projectId": "A String", # The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. - "labels": { # The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. + "projectId": "A String", # The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Read-only after creation. + "labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write. "a_key": "A String", }, "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only. - "lifecycleState": "A String", # The project lifecycle state. Read-only. + "lifecycleState": "A String", # The Project lifecycle state. Read-only. "createTime": "A String", # Creation time. Read-only. }
diff --git a/docs/dyn/cloudtrace_v1.html b/docs/dyn/cloudtrace_v1.html new file mode 100644 index 00000000000..f795ab4c733 --- /dev/null +++ b/docs/dyn/cloudtrace_v1.html @@ -0,0 +1,103 @@ + + + +

Google Cloud Trace API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudtrace_v1.projects.html b/docs/dyn/cloudtrace_v1.projects.html new file mode 100644 index 00000000000..1063fcdbb81 --- /dev/null +++ b/docs/dyn/cloudtrace_v1.projects.html @@ -0,0 +1,126 @@ + + + +

Google Cloud Trace API . projects

+

Instance Methods

+

+ traces() +

+

Returns the traces Resource.

+ +

+ patchTraces(projectId, body, x__xgafv=None)

+

Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.

+

Method Details

+
+ patchTraces(projectId, body, x__xgafv=None) +
Sends new traces to Cloud Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created.
+
+Args:
+  projectId: string, ID of the Cloud project where the trace data is stored. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # List of new or updated traces.
+    "traces": [ # List of traces.
+      { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
+        "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
+        "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
+        "spans": [ # Collection of spans in the trace.
+          { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
+            "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
+            "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Cloud Trace tool in the Google Developers Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
+            "labels": { # Collection of labels associated with the span.
+              "a_key": "A String",
+            },
+            "parentSpanId": "A String", # ID of the parent span, if any. Optional.
+            "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
+            "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
+            "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+          },
+        ],
+      },
+    ],
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudtrace_v1.projects.traces.html b/docs/dyn/cloudtrace_v1.projects.traces.html new file mode 100644 index 00000000000..1f3f2a2421f --- /dev/null +++ b/docs/dyn/cloudtrace_v1.projects.traces.html @@ -0,0 +1,174 @@ + + + +

Google Cloud Trace API . projects . traces

+

Instance Methods

+

+ get(projectId, traceId, x__xgafv=None)

+

Gets a single trace by its ID.

+

+ list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None)

+

Returns of a list of traces that match the specified filter conditions.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(projectId, traceId, x__xgafv=None) +
Gets a single trace by its ID.
+
+Args:
+  projectId: string, ID of the Cloud project where the trace data is stored. (required)
+  traceId: string, ID of the trace to return. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
+    "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
+    "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
+    "spans": [ # Collection of spans in the trace.
+      { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
+        "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
+        "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Cloud Trace tool in the Google Developers Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
+        "labels": { # Collection of labels associated with the span.
+          "a_key": "A String",
+        },
+        "parentSpanId": "A String", # ID of the parent span, if any. Optional.
+        "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
+        "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
+        "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+      },
+    ],
+  }
+
+ +
+ list(projectId, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None, view=None) +
Returns of a list of traces that match the specified filter conditions.
+
+Args:
+  projectId: string, ID of the Cloud project where the trace data is stored. (required)
+  orderBy: string, Field used to sort the returned traces. Optional. Can be one of the following: * `trace_id` * `name` (`name` field of root span in the trace) * `duration` (difference between `end_time` and `start_time` fields of the root span) * `start` (`start_time` field of the root span) Descending order can be specified by appending `desc` to the sort field (for example, `name desc`). Only one sort field is permitted.
+  startTime: string, End of the time interval (inclusive) during which the trace data was collected from the application.
+  pageSize: integer, Maximum number of traces to return. If not specified or <= 0, the implementation selects a reasonable value. The implementation may return fewer traces than the requested page size. Optional.
+  x__xgafv: string, V1 error format.
+  pageToken: string, Token identifying the page of results to return. If provided, use the value of the `next_page_token` field from a previous request. Optional.
+  filter: string, An optional filter for the request.
+  endTime: string, Start of the time interval (inclusive) during which the trace data was collected from the application.
+  view: string, Type of data returned for traces in the list. Optional. Default is `MINIMAL`.
+
+Returns:
+  An object of the form:
+
+    { # The response message for the `ListTraces` method.
+    "nextPageToken": "A String", # If defined, indicates that there are more traces that match the request and that this value should be passed to the next request to continue retrieving additional traces.
+    "traces": [ # List of trace records returned.
+      { # A trace describes how long it takes for an application to perform an operation. It consists of a set of spans, each of which represent a single timed event within the operation.
+        "projectId": "A String", # Project ID of the Cloud project where the trace data is stored.
+        "traceId": "A String", # Globally unique identifier for the trace. This identifier is a 128-bit numeric value formatted as a 32-byte hex string.
+        "spans": [ # Collection of spans in the trace.
+          { # A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
+            "kind": "A String", # Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `RPC_CLIENT` and `RPC_SERVER` to identify queueing latency associated with the span.
+            "name": "A String", # Name of the trace. The trace name is sanitized and displayed in the Cloud Trace tool in the Google Developers Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
+            "labels": { # Collection of labels associated with the span.
+              "a_key": "A String",
+            },
+            "parentSpanId": "A String", # ID of the parent span, if any. Optional.
+            "startTime": "A String", # Start time of the span in nanoseconds from the UNIX epoch.
+            "spanId": "A String", # Identifier for the span. This identifier must be unique within a trace.
+            "endTime": "A String", # End time of the span in nanoseconds from the UNIX epoch.
+          },
+        ],
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/clouduseraccounts_vm_alpha.globalAccountsOperations.html b/docs/dyn/clouduseraccounts_vm_alpha.globalAccountsOperations.html index 4ef25df98c8..e176e3d4a88 100644 --- a/docs/dyn/clouduseraccounts_vm_alpha.globalAccountsOperations.html +++ b/docs/dyn/clouduseraccounts_vm_alpha.globalAccountsOperations.html @@ -114,7 +114,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -135,7 +135,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -184,7 +184,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -205,7 +205,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. diff --git a/docs/dyn/clouduseraccounts_vm_alpha.groups.html b/docs/dyn/clouduseraccounts_vm_alpha.groups.html index 4b3070dde6a..4eed0aebc0d 100644 --- a/docs/dyn/clouduseraccounts_vm_alpha.groups.html +++ b/docs/dyn/clouduseraccounts_vm_alpha.groups.html @@ -131,7 +131,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -152,7 +152,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -187,7 +187,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -208,7 +208,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -363,7 +363,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -384,7 +384,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -485,7 +485,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -506,7 +506,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. diff --git a/docs/dyn/clouduseraccounts_vm_alpha.linux.html b/docs/dyn/clouduseraccounts_vm_alpha.linux.html index 6a2bc22972c..a4fa29417f2 100644 --- a/docs/dyn/clouduseraccounts_vm_alpha.linux.html +++ b/docs/dyn/clouduseraccounts_vm_alpha.linux.html @@ -75,14 +75,14 @@

Cloud User Accounts API . linux

Instance Methods

- getAuthorizedKeysView(project, zone, user, instance)

+ getAuthorizedKeysView(project, zone, user, instance, login=None)

Returns a list of authorized public keys for a specific user account.

getLinuxAccountViews(project, zone, instance, orderBy=None, filter=None, maxResults=None, pageToken=None)

Retrieves a list of user accounts for an instance within a specific project.

Method Details

- getAuthorizedKeysView(project, zone, user, instance) + getAuthorizedKeysView(project, zone, user, instance, login=None)
Returns a list of authorized public keys for a specific user account.
 
 Args:
@@ -90,6 +90,7 @@ 

Method Details

zone: string, Name of the zone for this request. (required) user: string, The user account for which you want to get a list of authorized public keys. (required) instance: string, The fully-qualified URL of the virtual machine requesting the view. (required) + login: boolean, Whether the view was requested as part of a user-initiated login. Returns: An object of the form: @@ -99,6 +100,7 @@

Method Details

"keys": [ # [Output Only] The list of authorized public keys in SSH format. "A String", ], + "sudoer": True or False, # [Output Only] Whether the user has the ability to elevate on the instance that requested the authorized keys. }, }
diff --git a/docs/dyn/clouduseraccounts_vm_alpha.users.html b/docs/dyn/clouduseraccounts_vm_alpha.users.html index 74a02912227..20bb7c1510e 100644 --- a/docs/dyn/clouduseraccounts_vm_alpha.users.html +++ b/docs/dyn/clouduseraccounts_vm_alpha.users.html @@ -133,7 +133,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -154,7 +154,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -189,7 +189,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -210,7 +210,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -385,7 +385,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -406,7 +406,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. @@ -509,7 +509,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "operationType": "A String", # [Output Only] Type of the operation, such as insert, compute.instanceGroups.update, or compute.instanceGroups.delete. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. "progress": 42, # [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. "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. @@ -530,7 +530,7 @@

Method Details

], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "kind": "clouduseraccounts#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html index 3ad597e3bb8..8949ac8f8dc 100644 --- a/docs/dyn/compute_v1.addresses.html +++ b/docs/dyn/compute_v1.addresses.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of addresses grouped by scope.

+

Retrieves an aggregated list of addresses.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,39 +91,44 @@

Instance Methods

Creates an address resource in the specified project using the data included in the request.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of address resources contained within the specified region.

+

Retrieves a list of addresses contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of addresses grouped by scope.
+  
Retrieves an aggregated list of addresses.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped address lists.
       "a_key": { # [Output Only] Name of the scope containing this set of addresses.
         "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
@@ -131,14 +136,14 @@ 

Method Details

{ # A reserved address resource. "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. "address": "A String", # The static external IP address represented by this resource. "users": [ # [Output Only] The URLs of the resources that are using this address. "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, @@ -178,35 +183,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -216,9 +223,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -237,14 +244,14 @@

Method Details

{ # A reserved address resource. "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. "address": "A String", # The static external IP address represented by this resource. "users": [ # [Output Only] The URLs of the resources that are using this address. "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -263,14 +270,14 @@

Method Details

{ # A reserved address resource. "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. "address": "A String", # The static external IP address represented by this resource. "users": [ # [Output Only] The URLs of the resources that are using this address. "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -280,35 +287,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -318,50 +327,54 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of address resources contained within the specified region.
+  
Retrieves a list of addresses contained within the specified region.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of address resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # [Output Only] A list of Address resources.
+    { # Contains a list of addresses.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of addresses.
       { # A reserved address resource.
           "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
           "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
           "address": "A String", # The static external IP address represented by this resource.
           "users": [ # [Output Only] The URLs of the resources that are using this address.
             "A String",
           ],
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   }
diff --git a/docs/dyn/compute_v1.autoscalers.html b/docs/dyn/compute_v1.autoscalers.html index 7de982cfe98..350a00249fd 100644 --- a/docs/dyn/compute_v1.autoscalers.html +++ b/docs/dyn/compute_v1.autoscalers.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of autoscalers grouped by scope.

+

Retrieves an aggregated list of autoscalers.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Instance Methods

Creates an autoscaler resource in the specified project using the data included in the request.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of autoscaler resources contained within the specified zone.

+

Retrieves a list of autoscaler resources contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -104,39 +104,44 @@

Instance Methods

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of autoscalers grouped by scope.
+  
Retrieves an aggregated list of autoscalers.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # A map of scoped autoscaler lists.
       "a_key": { # Name of the scope containing this set of autoscalers.
         "warning": { # Informational warning which replaces the list of autoscalers when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
         "autoscalers": [ # List of autoscalers contained in this scope.
           {
               "kind": "compute#autoscaler", # Type of the resource.
-              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
               "zone": "A String", # [Output Only] URL of the zone where the instance group resides.
               "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration.
                 "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.
@@ -158,7 +163,7 @@ 

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, @@ -166,7 +171,7 @@

Method Details

}, }, "kind": "compute#autoscalerAggregatedList", # Type of resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -190,7 +195,7 @@

Method Details

Deletes the specified autoscaler resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   autoscaler: string, Name of the persistent autoscaler resource to delete. (required)
 
@@ -198,35 +203,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -236,9 +243,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -247,7 +254,7 @@

Method Details

Returns the specified autoscaler resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   autoscaler: string, Name of the persistent autoscaler resource to return. (required)
 
@@ -256,7 +263,7 @@ 

Method Details

{ "kind": "compute#autoscaler", # Type of the resource. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "zone": "A String", # [Output Only] URL of the zone where the instance group resides. "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration. "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend. @@ -278,7 +285,7 @@

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -289,14 +296,14 @@

Method Details

Creates an autoscaler resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "kind": "compute#autoscaler", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "zone": "A String", # [Output Only] URL of the zone where the instance group resides.
     "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration.
       "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.
@@ -318,7 +325,7 @@ 

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -328,35 +335,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -366,36 +375,40 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of autoscaler resources contained within the specified zone.
+  
Retrieves a list of autoscaler resources contained within the specified zone.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of persistent autoscaler resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of Autoscaler resources.
       {
           "kind": "compute#autoscaler", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "zone": "A String", # [Output Only] URL of the zone where the instance group resides.
           "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration.
             "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.
@@ -417,13 +430,13 @@ 

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#autoscalerList", # Type of resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -447,7 +460,7 @@

Method Details

Updates an autoscaler resource in the specified project using the data included in the request. This method supports patch semantics.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   autoscaler: string, Name of the autoscaler resource to update. (required)
   body: object, The request body. (required)
@@ -455,7 +468,7 @@ 

Method Details

{ "kind": "compute#autoscaler", # Type of the resource. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "zone": "A String", # [Output Only] URL of the zone where the instance group resides. "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration. "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend. @@ -477,7 +490,7 @@

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -487,35 +500,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -525,9 +540,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -536,14 +551,14 @@

Method Details

Updates an autoscaler resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "kind": "compute#autoscaler", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "zone": "A String", # [Output Only] URL of the zone where the instance group resides.
     "autoscalingPolicy": { # Cloud Autoscaler policy. # Autoscaling configuration.
       "maxNumReplicas": 42, # The maximum number of replicas that the Autoscaler can scale up to. This field is required for config to be effective. Maximum number of replicas should be not lower than minimal number of replicas. Absolute limit for this value is defined in Autoscaler backend.
@@ -565,7 +580,7 @@ 

Method Details

}, "target": "A String", # URL of Instance Group Manager or Replica Pool which will be controlled by Autoscaler. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -576,35 +591,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -614,9 +631,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index adc21bee022..00e02f516a1 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -85,7 +85,7 @@

Instance Methods

Gets the most recent health check results for this BackendService.

insert(project, body)

-

Creates a BackendService resource in the specified project using the data included in the request.

+

Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.

list(project, maxResults=None, pageToken=None, filter=None)

Retrieves the list of BackendService resources available to the specified project.

@@ -94,52 +94,54 @@

Instance Methods

Retrieves the next page of results.

patch(project, backendService, body)

-

Update the entire content of the BackendService resource. This method supports patch semantics.

+

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.

update(project, backendService, body)

-

Update the entire content of the BackendService resource.

+

Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.

Method Details

delete(project, backendService)
Deletes the specified BackendService resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   backendService: string, Name of the BackendService resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -149,9 +151,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -160,38 +162,40 @@

Method Details

Returns the specified BackendService resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   backendService: string, Name of the BackendService resource to return. (required)
 
 Returns:
   An object of the form:
 
-    { # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
+    { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
       "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
-      "protocol": "A String",
-      "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+      "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+          #
+          # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-      "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
+      "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
       "backends": [ # The list of backends that serve this BackendService.
         { # Message containing information of one individual backend.
           "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
               #
               # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
-          "maxRatePerInstance": 3.14, # The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+          "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
           "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
-          "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
-          "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
+          "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+          "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
         },
       ],
       "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
-      "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
-      "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+      "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
+      "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
         "A String",
       ],
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -230,39 +234,41 @@

Method Details

insert(project, body) -
Creates a BackendService resource in the specified project using the data included in the request.
+  
Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read  Restrictions and Guidelines for more information.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
     "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
-    "protocol": "A String",
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+        # 
+        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-    "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
+    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
     "backends": [ # The list of backends that serve this BackendService.
       { # Message containing information of one individual backend.
         "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
             #
             # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
-        "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
-        "maxRatePerInstance": 3.14, # The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
         "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
-        "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
-        "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
+        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
       },
     ],
     "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
-    "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
-    "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
+    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
       "A String",
     ],
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -272,35 +278,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -310,9 +318,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -321,53 +329,59 @@

Method Details

Retrieves the list of BackendService resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of BackendService resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of BackendService resources.
-      { # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
+      { # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
           "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
-          "protocol": "A String",
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+              #
+              # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-          "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
+          "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
           "backends": [ # The list of backends that serve this BackendService.
             { # Message containing information of one individual backend.
               "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
                   #
                   # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
-              "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
               "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
-              "maxRatePerInstance": 3.14, # The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+              "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
               "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
-              "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
-              "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
+              "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+              "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
             },
           ],
           "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
-          "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
-          "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+          "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
+          "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
             "A String",
           ],
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#backendServiceList", # [Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
   }
@@ -388,40 +402,42 @@

Method Details

patch(project, backendService, body) -
Update the entire content of the BackendService resource. This method supports patch semantics.
+  
Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information. This method supports patch semantics.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   backendService: string, Name of the BackendService resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
     "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
-    "protocol": "A String",
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+        # 
+        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-    "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
+    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
     "backends": [ # The list of backends that serve this BackendService.
       { # Message containing information of one individual backend.
         "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
             #
             # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
-        "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
-        "maxRatePerInstance": 3.14, # The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
         "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
-        "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
-        "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
+        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
       },
     ],
     "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
-    "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
-    "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
+    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
       "A String",
     ],
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -431,35 +447,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -469,48 +487,50 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
update(project, backendService, body) -
Update the entire content of the BackendService resource.
+  
Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read  Restrictions and Guidelines for more information.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   backendService: string, Name of the BackendService resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A BackendService resource. This resource defines a group of backend virtual machines together with their serving capacity.
+{ # A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
     "kind": "compute#backendService", # [Output Only] Type of resource. Always compute#backendService for backend services.
-    "protocol": "A String",
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "protocol": "A String", # The protocol this BackendService uses to communicate with backends.
+        # 
+        # Possible values are HTTP, HTTPS, HTTP2, TCP and SSL.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.
-    "port": 42, # Deprecated in favor of port name. The TCP port to connect on the backend. The default value is 80.
+    "port": 42, # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.
     "backends": [ # The list of backends that serve this BackendService.
       { # Message containing information of one individual backend.
         "group": "A String", # The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.
             #
             # Note that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL.
-        "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         "maxUtilization": 3.14, # Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].
-        "maxRatePerInstance": 3.14, # The max RPS that a single backed instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "maxRatePerInstance": 3.14, # The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
         "capacityScaler": 3.14, # A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].
-        "maxRate": 42, # The max RPS of the group. Can be used with either balancing mode, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
-        "balancingMode": "A String", # Specifies the balancing mode for this backend. The default is UTILIZATION but available values are UTILIZATION and RATE.
+        "maxRate": 42, # The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.
+        "balancingMode": "A String", # Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.
       },
     ],
     "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService.
-    "portName": "A String", # Name of backend port. The same name should appear in the resource views referenced by this service. Required.
-    "healthChecks": [ # The list of URLs to the HttpHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
+    "portName": "A String", # Name of backend port. The same name should appear in the instance groups referenced by this service. Required.
+    "healthChecks": [ # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.
       "A String",
     ],
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -520,35 +540,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -558,9 +580,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.diskTypes.html b/docs/dyn/compute_v1.diskTypes.html index 90d6f3c7dc0..0735e1e6058 100644 --- a/docs/dyn/compute_v1.diskTypes.html +++ b/docs/dyn/compute_v1.diskTypes.html @@ -76,55 +76,60 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of disk type resources grouped by scope.

+

Retrieves an aggregated list of disk types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, diskType)

-

Returns the specified disk type resource.

+

Returns the specified disk type.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of disk type resources available to the specified project.

+

Retrieves a list of disk types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of disk type resources grouped by scope.
+  
Retrieves an aggregated list of disk types.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped disk type lists.
       "a_key": { # [Output Only] Name of the scope containing this set of disk types.
         "warning": { # [Output Only] Informational warning which replaces the list of disk types when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
         "diskTypes": [ # [Output Only] List of disk types contained in this scope.
-          { # A disk type resource.
+          { # A DiskType resource.
             "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
-            "description": "A String", # [Output Only] An optional textual description of the resource.
+            "description": "A String", # [Output Only] An optional description of this resource.
             "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
             "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
             "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
@@ -136,7 +141,7 @@ 

Method Details

}, "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, @@ -144,7 +149,7 @@

Method Details

}, }, "kind": "compute#diskTypeAggregatedList", # [Output Only] Type of resource. Always compute#diskTypeAggregatedList. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -165,19 +170,19 @@

Method Details

get(project, zone, diskType) -
Returns the specified disk type resource.
+  
Returns the specified disk type.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  diskType: string, Name of the disk type resource to return. (required)
+  diskType: string, Name of the disk type to return. (required)
 
 Returns:
   An object of the form:
 
-    { # A disk type resource.
+    { # A DiskType resource.
     "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
-    "description": "A String", # [Output Only] An optional textual description of the resource.
+    "description": "A String", # [Output Only] An optional description of this resource.
     "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
     "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
     "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
@@ -189,7 +194,7 @@ 

Method Details

}, "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }
@@ -197,28 +202,32 @@

Method Details

list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of disk type resources available to the specified project.
+  
Retrieves a list of disk types available to the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of disk type resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    { # Contains a list of disk types.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of Disk Type resources.
-      { # A disk type resource.
+      { # A DiskType resource.
         "kind": "compute#diskType", # [Output Only] Type of the resource. Always compute#diskType for disk types.
-        "description": "A String", # [Output Only] An optional textual description of the resource.
+        "description": "A String", # [Output Only] An optional description of this resource.
         "zone": "A String", # [Output Only] URL of the zone where the disk type resides.
         "validDiskSize": "A String", # [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB".
         "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
@@ -230,13 +239,13 @@ 

Method Details

}, "defaultDiskSizeGb": "A String", # [Output Only] Server-defined default disk size in GB. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, ], "kind": "compute#diskTypeList", # [Output Only] Type of resource. Always compute#diskTypeList for disk types. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html index 59ea1b2920c..158f79ccc7e 100644 --- a/docs/dyn/compute_v1.disks.html +++ b/docs/dyn/compute_v1.disks.html @@ -76,13 +76,13 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of disks grouped by scope.

+

Retrieves an aggregated list of persistent disks.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

createSnapshot(project, zone, disk, body)

-

Creates a snapshot of this disk.

+

Creates a snapshot of a specified persistent disk.

delete(project, zone, disk)

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

@@ -91,33 +91,37 @@

Instance Methods

Returns a specified persistent disk.

insert(project, zone, body, sourceImage=None)

-

Creates a persistent disk in the specified project using the data included in the request.

+

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.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of persistent disks contained within the specified zone.

+

Retrieves a list of persistent disks contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of disks grouped by scope.
+  
Retrieves an aggregated list of persistent disks.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped disk lists.
       "a_key": { # [Output Only] Name of the scope containing this set of disks.
         "disks": [ # [Output Only] List of disks contained in this scope.
@@ -129,13 +133,13 @@ 

Method Details

# - global/snapshots/snapshot "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. # # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. - "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created. + "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. "options": "A String", # Internal use only. - "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. + "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. "sourceImage": "A String", # 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. @@ -149,33 +153,42 @@

Method Details

# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD # # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. - "licenses": [ # Any applicable publicly visible licenses. + # + # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example: + # + # global/images/family/my-private-family + # + # Or 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: + # + # projects/debian-cloud/global/images/family/debian-7 + "licenses": [ # [Output Only] Any applicable publicly visible licenses. "A String", ], - "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance "A String", ], "zone": "A String", # [Output Only] URL of the zone where the disk resides. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -196,7 +209,7 @@

Method Details

createSnapshot(project, zone, disk, body) -
Creates a snapshot of this disk.
+  
Creates a snapshot of a specified persistent disk.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -206,19 +219,19 @@ 

Method Details

The object takes the form of: { # A persistent disk snapshot resource. - "status": "A String", # [Output Only] The status of the snapshot. + "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. - "sourceDisk": "A String", # The source disk used to create this snapshot. - "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot. + "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB. - "licenses": [ # Public visible licenses. + "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -228,35 +241,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -266,9 +281,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -285,35 +300,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -323,9 +340,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -349,13 +366,13 @@

Method Details

# - global/snapshots/snapshot "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. # # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. - "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created. + "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. "options": "A String", # Internal use only. - "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. + "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. "sourceImage": "A String", # 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. @@ -369,15 +386,23 @@

Method Details

# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD # # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. - "licenses": [ # Any applicable publicly visible licenses. + # + # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example: + # + # global/images/family/my-private-family + # + # Or 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: + # + # projects/debian-cloud/global/images/family/debian-7 + "licenses": [ # [Output Only] Any applicable publicly visible licenses. "A String", ], - "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance "A String", ], "zone": "A String", # [Output Only] URL of the zone where the disk resides. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -385,7 +410,7 @@

Method Details

insert(project, zone, body, sourceImage=None) -
Creates a persistent disk in the specified project using the data included in the request.
+  
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.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -401,13 +426,13 @@ 

Method Details

# - global/snapshots/snapshot "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. # # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. - "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created. + "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. "options": "A String", # Internal use only. - "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. + "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. "sourceImage": "A String", # 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. @@ -421,15 +446,23 @@

Method Details

# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD # # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. - "licenses": [ # Any applicable publicly visible licenses. + # + # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example: + # + # global/images/family/my-private-family + # + # Or 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: + # + # projects/debian-cloud/global/images/family/debian-7 + "licenses": [ # [Output Only] Any applicable publicly visible licenses. "A String", ], - "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance "A String", ], "zone": "A String", # [Output Only] URL of the zone where the disk resides. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -440,35 +473,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -478,32 +513,36 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of persistent disks contained within the specified zone.
+  
Retrieves a list of persistent disks contained within the specified zone.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # A list of Disk resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of persistent disks.
       { # A Disk resource.
           "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
@@ -513,13 +552,13 @@ 

Method Details

# - global/snapshots/snapshot "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks. "lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. # # If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. - "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created. + "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. "options": "A String", # Internal use only. - "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. + "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. "sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. "lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format. "sourceImage": "A String", # 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. @@ -533,21 +572,29 @@

Method Details

# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD # # where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases. - "licenses": [ # Any applicable publicly visible licenses. + # + # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example: + # + # global/images/family/my-private-family + # + # Or 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: + # + # projects/debian-cloud/global/images/family/debian-7 + "licenses": [ # [Output Only] Any applicable publicly visible licenses. "A String", ], - "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance + "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance "A String", ], "zone": "A String", # [Output Only] URL of the zone where the disk resides. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html index 5cea5d4f73a..65f44f34182 100644 --- a/docs/dyn/compute_v1.firewalls.html +++ b/docs/dyn/compute_v1.firewalls.html @@ -76,67 +76,69 @@

Compute Engine API . delete(project, firewall)

-

Deletes the specified firewall resource.

+

Deletes the specified firewall.

get(project, firewall)

-

Returns the specified firewall resource.

+

Returns the specified firewall.

insert(project, body)

-

Creates a firewall resource in the specified project using the data included in the request.

+

Creates a firewall rule in the specified project using the data included in the request.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of firewall resources available to the specified project.

+

Retrieves the list of firewall rules available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(project, firewall, body)

-

Updates the specified firewall resource with the data included in the request. This method supports patch semantics.

+

Updates the specified firewall rule with the data included in the request. This method supports patch semantics.

update(project, firewall, body)

-

Updates the specified firewall resource with the data included in the request.

+

Updates the specified firewall rule with the data included in the request.

Method Details

delete(project, firewall) -
Deletes the specified firewall resource.
+  
Deletes the specified firewall.
 
 Args:
   project: string, Project ID for this request. (required)
-  firewall: string, Name of the firewall resource to delete. (required)
+  firewall: string, Name of the firewall rule to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -146,26 +148,26 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, firewall) -
Returns the specified firewall resource.
+  
Returns the specified firewall.
 
 Args:
   project: string, Project ID for this request. (required)
-  firewall: string, Name of the firewall resource to return. (required)
+  firewall: string, Name of the firewall rule to return. (required)
 
 Returns:
   An object of the form:
 
-    { # A Firewall resource.
+    { # Represents a Firewall resource.
       "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
           #
           # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
@@ -176,7 +178,7 @@ 

Method Details

# If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties. "A String", ], - "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: + "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network @@ -187,7 +189,7 @@

Method Details

], "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. { - "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. + "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed # # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. @@ -196,7 +198,7 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -204,16 +206,16 @@

Method Details

insert(project, body) -
Creates a firewall resource in the specified project using the data included in the request.
+  
Creates a firewall rule in the specified project using the data included in the request.
 
 Args:
   project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A Firewall resource.
+{ # Represents a Firewall resource.
     "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
         # 
         # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
@@ -224,7 +226,7 @@ 

Method Details

# If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties. "A String", ], - "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: + "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network @@ -235,7 +237,7 @@

Method Details

], "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. { - "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. + "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed # # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. @@ -244,7 +246,7 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -254,35 +256,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -292,35 +296,39 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of firewall resources available to the specified project.
+  
Retrieves the list of firewall rules available to the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of Firewall resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    { # Contains a list of firewalls.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of Firewall resources.
-      { # A Firewall resource.
+      { # Represents a Firewall resource.
           "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
               #
               # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
@@ -331,7 +339,7 @@ 

Method Details

# If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties. "A String", ], - "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: + "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network @@ -342,7 +350,7 @@

Method Details

], "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. { - "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. + "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed # # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. @@ -351,13 +359,13 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#firewallList", # [Output Only] Type of resource. Always compute#firewallList for lists of firewalls. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -378,17 +386,17 @@

Method Details

patch(project, firewall, body) -
Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
+  
Updates the specified firewall rule with the data included in the request. This method supports patch semantics.
 
 Args:
   project: string, Project ID for this request. (required)
-  firewall: string, Name of the firewall resource to update. (required)
+  firewall: string, Name of the firewall rule to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A Firewall resource.
+{ # Represents a Firewall resource.
     "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
         # 
         # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
@@ -399,7 +407,7 @@ 

Method Details

# If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties. "A String", ], - "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: + "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network @@ -410,7 +418,7 @@

Method Details

], "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. { - "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. + "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed # # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. @@ -419,7 +427,7 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -429,35 +437,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -467,25 +477,25 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
update(project, firewall, body) -
Updates the specified firewall resource with the data included in the request.
+  
Updates the specified firewall rule with the data included in the request.
 
 Args:
   project: string, Project ID for this request. (required)
-  firewall: string, Name of the firewall resource to update. (required)
+  firewall: string, Name of the firewall rule to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A Firewall resource.
+{ # Represents a Firewall resource.
     "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "sourceTags": [ # A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.
         # 
         # If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.
@@ -496,7 +506,7 @@ 

Method Details

# If both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties. "A String", ], - "network": "A String", # URL of the network resource for this firewall rule. This field is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: + "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: # global/networks/default # If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network @@ -507,7 +517,7 @@

Method Details

], "allowed": [ # The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. { - "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. + "IPProtocol": "A String", # The IP protocol that is allowed for this rule. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number. "ports": [ # An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed # # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. @@ -516,7 +526,7 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -526,35 +536,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -564,9 +576,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html index bfbfcaceb94..d9aeb4e8e5c 100644 --- a/docs/dyn/compute_v1.forwardingRules.html +++ b/docs/dyn/compute_v1.forwardingRules.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of forwarding rules grouped by scope.

+

Retrieves an aggregated list of forwarding rules.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,64 +91,69 @@

Instance Methods

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of ForwardingRule resources available to the specified project and region.

+

Retrieves a list of ForwardingRule resources available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, region, forwardingRule, body)

-

Changes target url for forwarding rule.

+

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of forwarding rules grouped by scope.
+  
Retrieves an aggregated list of forwarding rules.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # A map of scoped forwarding rule lists.
       "a_key": { # Name of the scope containing this set of addresses.
         "forwardingRules": [ # List of forwarding rules contained in this scope.
           { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-              "kind": "compute#forwardingRule", # Type of the resource.
-              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+              "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
               "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
               "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-              "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-              "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+              "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+              "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
               "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
               "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-              "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
               "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
               "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
             },
         ],
         "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
       },
     },
-    "kind": "compute#forwardingRuleAggregatedList", # Type of resource.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "kind": "compute#forwardingRuleAggregatedList", # [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
   }
@@ -172,7 +177,7 @@

Method Details

Deletes the specified ForwardingRule resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
 
@@ -180,35 +185,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -218,9 +225,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -229,7 +236,7 @@

Method Details

Returns the specified ForwardingRule resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource to return. (required)
 
@@ -237,15 +244,15 @@ 

Method Details

An object of the form: { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple. - "kind": "compute#forwardingRule", # Type of the resource. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned. "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. - "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic. + "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -256,21 +263,21 @@

Method Details

Creates a ForwardingRule resource in the specified project and region using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-    "kind": "compute#forwardingRule", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
     "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-    "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
     "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -280,35 +287,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -318,43 +327,47 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of ForwardingRule resources available to the specified project and region.
+  
Retrieves a list of ForwardingRule resources available to the specified project and region.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of ForwardingRule resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of ForwardingRule resources.
       { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-          "kind": "compute#forwardingRule", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
           "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-          "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
           "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
@@ -381,10 +394,10 @@ 

Method Details

setTarget(project, region, forwardingRule, body) -
Changes target url for forwarding rule.
+  
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
   body: object, The request body. (required)
@@ -399,35 +412,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -437,9 +452,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html index 59b59d36d56..d721ae7ec64 100644 --- a/docs/dyn/compute_v1.globalAddresses.html +++ b/docs/dyn/compute_v1.globalAddresses.html @@ -85,7 +85,7 @@

Instance Methods

Creates an address resource in the specified project using the data included in the request.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of global address resources.

+

Retrieves a list of global addresses.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -102,35 +102,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -140,9 +142,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -160,14 +162,14 @@

Method Details

{ # A reserved address resource. "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. "address": "A String", # The static external IP address represented by this resource. "users": [ # [Output Only] The URLs of the resources that are using this address. "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -185,14 +187,14 @@

Method Details

{ # A reserved address resource. "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. "address": "A String", # The static external IP address represented by this resource. "users": [ # [Output Only] The URLs of the resources that are using this address. "A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -202,35 +204,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -240,49 +244,53 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of global address resources.
+  
Retrieves a list of global addresses.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of address resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # [Output Only] A list of Address resources.
+    { # Contains a list of addresses.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of addresses.
       { # A reserved address resource.
           "status": "A String", # [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
           "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "region": "A String", # [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
           "address": "A String", # The static external IP address represented by this resource.
           "users": [ # [Output Only] The URLs of the resources that are using this address.
             "A String",
           ],
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   }
diff --git a/docs/dyn/compute_v1.globalForwardingRules.html b/docs/dyn/compute_v1.globalForwardingRules.html index 32cd6bb7fe4..94bd50ef929 100644 --- a/docs/dyn/compute_v1.globalForwardingRules.html +++ b/docs/dyn/compute_v1.globalForwardingRules.html @@ -85,55 +85,57 @@

Instance Methods

Creates a ForwardingRule resource in the specified project and region using the data included in the request.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of ForwardingRule resources available to the specified project.

+

Retrieves a list of ForwardingRule resources available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

setTarget(project, forwardingRule, body)

-

Changes target url for forwarding rule.

+

Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Method Details

delete(project, forwardingRule)
Deletes the specified ForwardingRule resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -143,9 +145,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -154,22 +156,22 @@

Method Details

Returns the specified ForwardingRule resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource to return. (required)
 
 Returns:
   An object of the form:
 
     { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-      "kind": "compute#forwardingRule", # Type of the resource.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+      "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
       "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-      "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+      "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+      "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
       "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -180,20 +182,20 @@

Method Details

Creates a ForwardingRule resource in the specified project and region using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-    "kind": "compute#forwardingRule", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
     "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-    "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+    "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+    "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
     "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -203,35 +205,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -241,42 +245,46 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of ForwardingRule resources available to the specified project.
+  
Retrieves a list of ForwardingRule resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of ForwardingRule resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of ForwardingRule resources.
       { # A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.
-          "kind": "compute#forwardingRule", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "kind": "compute#forwardingRule", # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "IPAddress": "A String", # Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned.
           "region": "A String", # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
-          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource.
-          "portRange": "A String", # Applicable only when `IPProtocol` is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. If portRange is left empty (default value), all ports are forwarded. Forwarding rules with the same `[IPAddress, IPProtocol]` pair must have disjoint port ranges.
+          "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic.
+          "portRange": "A String", # Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
           "IPProtocol": "A String", # The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH or SCTP.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
@@ -303,10 +311,10 @@ 

Method Details

setTarget(project, forwardingRule, body) -
Changes target url for forwarding rule.
+  
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
   body: object, The request body. (required)
     The object takes the form of:
@@ -320,35 +328,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -358,9 +368,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.globalOperations.html b/docs/dyn/compute_v1.globalOperations.html index d07ef3a4d23..e1d0ff8725b 100644 --- a/docs/dyn/compute_v1.globalOperations.html +++ b/docs/dyn/compute_v1.globalOperations.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of all operations grouped by scope.

+

Retrieves an aggregated list of all operations.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -88,63 +88,69 @@

Instance Methods

Retrieves the specified Operations resource.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of Operation resources contained within the specified project.

+

Retrieves a list of Operation resources contained within the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of all operations grouped by scope.
+  
Retrieves an aggregated list of all operations.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped operation lists.
       "a_key": { # [Output Only] Name of the scope containing this set of operations.
         "operations": [ # [Output Only] List of operations contained in this scope.
           { # An Operation resource, used to manage asynchronous API requests.
-            "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-            "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+            "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+            "clientOperationId": "A String", # [Output Only] Reserved for future use.
             "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-            "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-            "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-            "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+            "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+            "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+            "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
             "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-            "progress": 42, # [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.
-            "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+            "progress": 42, # [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.
+            "httpErrorStatusCode": 42, # [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.
             "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-            "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-            "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+            "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+            "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
             "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
               {
-                "message": "A String", # [Output Only] Optional human-readable details for this warning.
-                "code": "A String", # [Output Only] The warning type identifier for this warning.
-                "data": [ # [Output Only] Metadata for this warning in key: value format.
+                "message": "A String", # [Output Only] A human-readable description of the warning code.
+                "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+                "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                    # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                   {
                     "value": "A String", # [Output Only] A warning data value corresponding to the key.
-                    "key": "A String", # [Output Only] A key for the warning data.
+                    "key": "A String", # [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).
                   },
                 ],
               },
             ],
             "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-            "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+            "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+            "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
             "name": "A String", # [Output Only] Name of the resource.
-            "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+            "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
             "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
               "errors": [ # [Output Only] The array of errors encountered while processing this operation.
                 {
@@ -154,25 +160,26 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, ], "warning": { # [Output Only] Informational warning which replaces the list of operations when the list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#operationAggregatedList", # [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -213,35 +220,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -251,62 +260,68 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of Operation resources contained within the specified project.
+  
Retrieves a list of Operation resources contained within the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of Operation resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
-    "items": [ # [Output Only] The Operation resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Operation resources.
       { # An Operation resource, used to manage asynchronous API requests.
-        "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-        "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+        "clientOperationId": "A String", # [Output Only] Reserved for future use.
         "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-        "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-        "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
         "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-        "progress": 42, # [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.
-        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+        "progress": 42, # [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.
+        "httpErrorStatusCode": 42, # [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.
         "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
         "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
           {
-            "message": "A String", # [Output Only] Optional human-readable details for this warning.
-            "code": "A String", # [Output Only] The warning type identifier for this warning.
-            "data": [ # [Output Only] Metadata for this warning in key: value format.
+            "message": "A String", # [Output Only] A human-readable description of the warning code.
+            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
               {
                 "value": "A String", # [Output Only] A warning data value corresponding to the key.
-                "key": "A String", # [Output Only] A key for the warning data.
+                "key": "A String", # [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).
               },
             ],
           },
         ],
         "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
         "name": "A String", # [Output Only] Name of the resource.
-        "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
         "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
           "errors": [ # [Output Only] The array of errors encountered while processing this operation.
             {
@@ -316,13 +331,13 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, ], "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html index 2306ab1eddc..8ec77d3496c 100644 --- a/docs/dyn/compute_v1.html +++ b/docs/dyn/compute_v1.html @@ -129,6 +129,11 @@

Instance Methods

Returns the httpHealthChecks Resource.

+

+ httpsHealthChecks() +

+

Returns the httpsHealthChecks Resource.

+

images()

@@ -194,11 +199,26 @@

Instance Methods

Returns the snapshots Resource.

+

+ sslCertificates() +

+

Returns the sslCertificates Resource.

+ +

+ subnetworks() +

+

Returns the subnetworks Resource.

+

targetHttpProxies()

Returns the targetHttpProxies Resource.

+

+ targetHttpsProxies() +

+

Returns the targetHttpsProxies Resource.

+

targetInstances()

diff --git a/docs/dyn/compute_v1.httpHealthChecks.html b/docs/dyn/compute_v1.httpHealthChecks.html index 8f62f4dd6c5..cae6634873d 100644 --- a/docs/dyn/compute_v1.httpHealthChecks.html +++ b/docs/dyn/compute_v1.httpHealthChecks.html @@ -101,42 +101,44 @@

Method Details

Deletes the specified HttpHealthCheck resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -146,9 +148,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -157,24 +159,24 @@

Method Details

Returns the specified HttpHealthCheck resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
 
 Returns:
   An object of the form:
 
     { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
-      "kind": "compute#httpHealthCheck", # Type of the resource.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+      "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
       "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
       "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
       "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
       "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
-      "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
+      "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
       "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -185,22 +187,22 @@

Method Details

Creates a HttpHealthCheck resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
-    "kind": "compute#httpHealthCheck", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
     "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
     "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
     "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
     "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
-    "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
+    "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
     "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -210,35 +212,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -248,9 +252,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -259,33 +263,37 @@

Method Details

Retrieves the list of HttpHealthCheck resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of HttpHealthCheck resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of HttpHealthCheck resources.
       { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
-          "kind": "compute#httpHealthCheck", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
           "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
           "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
           "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
           "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
-          "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
+          "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
           "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
@@ -315,23 +323,23 @@ 

Method Details

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
-    "kind": "compute#httpHealthCheck", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
     "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
     "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
     "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
     "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
-    "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
+    "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
     "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -341,35 +349,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -379,9 +389,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -390,23 +400,23 @@

Method Details

Updates a HttpHealthCheck resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
-    "kind": "compute#httpHealthCheck", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
     "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
     "port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
     "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
     "host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
-    "requestPath": "A String", # The request path of the HTTP health check request. The default value is "/".
+    "requestPath": "A String", # The request path of the HTTP health check request. The default value is /.
     "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -416,35 +426,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -454,9 +466,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.httpsHealthChecks.html b/docs/dyn/compute_v1.httpsHealthChecks.html new file mode 100644 index 00000000000..898f49083bc --- /dev/null +++ b/docs/dyn/compute_v1.httpsHealthChecks.html @@ -0,0 +1,475 @@ + + + +

Compute Engine API . httpsHealthChecks

+

Instance Methods

+

+ delete(project, httpsHealthCheck)

+

Deletes the specified HttpsHealthCheck resource.

+

+ get(project, httpsHealthCheck)

+

Returns the specified HttpsHealthCheck resource.

+

+ insert(project, body)

+

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

+

+ list(project, maxResults=None, pageToken=None, filter=None)

+

Retrieves the list of HttpsHealthCheck resources available to the specified project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(project, httpsHealthCheck, body)

+

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.

+

+ update(project, httpsHealthCheck, body)

+

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

+

Method Details

+
+ delete(project, httpsHealthCheck) +
Deletes the specified HttpsHealthCheck resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to delete. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ get(project, httpsHealthCheck) +
Returns the specified HttpsHealthCheck resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to return. (required)
+
+Returns:
+  An object of the form:
+
+    { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+      "kind": "compute#httpsHealthCheck", # Type of the resource.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+      "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+      "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
+      "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+      "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
+      "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
+      "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    }
+
+ +
+ insert(project, body) +
Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+    "kind": "compute#httpsHealthCheck", # Type of the resource.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+    "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
+    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+    "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
+    "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
+    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ list(project, maxResults=None, pageToken=None, filter=None) +
Retrieves the list of HttpsHealthCheck resources available to the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of HttpsHealthCheck resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # A list of HttpsHealthCheck resources.
+      { # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+          "kind": "compute#httpsHealthCheck", # Type of the resource.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+          "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+          "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
+          "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+          "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
+          "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
+          "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+        },
+    ],
+    "kind": "compute#httpsHealthCheckList", # Type of resource.
+    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(project, httpsHealthCheck, body) +
Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
+
+Args:
+  project: string, Project ID for this request. (required)
+  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+    "kind": "compute#httpsHealthCheck", # Type of the resource.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+    "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
+    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+    "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
+    "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
+    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ update(project, httpsHealthCheck, body) +
Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  httpsHealthCheck: string, Name of the HttpsHealthCheck resource to update. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
+    "kind": "compute#httpsHealthCheck", # Type of the resource.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
+    "checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
+    "port": 42, # The TCP port number for the HTTPS health check request. The default value is 443.
+    "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
+    "host": "A String", # The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
+    "requestPath": "A String", # The request path of the HTTPS health check request. The default value is "/".
+    "unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html index a2593deb885..24181fcf3df 100644 --- a/docs/dyn/compute_v1.images.html +++ b/docs/dyn/compute_v1.images.html @@ -76,26 +76,26 @@

Compute Engine API . delete(project, image)

-

Deletes the specified image resource.

+

Deletes the specified image.

deprecate(project, image, body)

Sets the deprecation status of an image.

get(project, image)

-

Returns the specified image resource.

+

Returns the specified image.

insert(project, body)

-

Creates an image resource in the specified project using the data included in the request.

+

Creates an image in the specified project using the data included in the request.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of image resources available to the specified project.

+

Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, image) -
Deletes the specified image resource.
+  
Deletes the specified image.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -105,35 +105,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -143,9 +145,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -174,35 +176,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -212,15 +216,15 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, image) -
Returns the specified image resource.
+  
Returns the specified image.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -232,7 +236,7 @@ 

Method Details

{ # An Image resource. "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. - "description": "A String", # Textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "rawDisk": { # The parameters of the raw disk image. "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. @@ -257,7 +261,7 @@

Method Details

], "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -265,7 +269,7 @@

Method Details

insert(project, body) -
Creates an image resource in the specified project using the data included in the request.
+  
Creates an image in the specified project using the data included in the request.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -275,7 +279,7 @@ 

Method Details

{ # An Image resource. "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. - "description": "A String", # Textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "rawDisk": { # The parameters of the raw disk image. "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. @@ -300,7 +304,7 @@

Method Details

], "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -310,35 +314,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -348,36 +354,42 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of image resources available to the specified project.
+  
Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
+
+See Accessing images for more information.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of Image resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # A list of Image resources.
+    { # Contains a list of images.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Image resources.
       { # An Image resource.
           "status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.
           "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.
-          "description": "A String", # Textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "rawDisk": { # The parameters of the raw disk image.
             "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
             "source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.
@@ -402,13 +414,13 @@ 

Method Details

], "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#imageList", # Type of resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index 0c0ca8a0d4d..f17f13f6af7 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -76,60 +76,60 @@

Compute Engine API . abandonInstances(project, zone, instanceGroupManager, body)

-

Removes the specified instances from the managed instance group, and from any target pools where they are a member. The instances are not deleted. The managed instance group automatically reduces its targetSize value by the number of instances that you abandon from the group.

+

Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.

aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of managed instance groups, and groups them by project and zone.

+

Retrieves the list of managed instance groups and groups them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroupManager)

-

Deletes the specified managed instance group resource.

+

Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.

deleteInstances(project, zone, instanceGroupManager, body)

-

Deletes the specified instances. The instances are deleted and removed from the instance group and any target pools where they are a member. The managed instance group automatically reduces its targetSize value by the number of instances that you delete.

+

Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.

get(project, zone, instanceGroupManager)

-

Returns the specified managed instance group resource.

+

Returns all of the details about the specified managed instance group.

insert(project, zone, body)

-

Creates a managed instance group resource in the specified project using the data that is included in the request.

+

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.

list(project, zone, maxResults=None, pageToken=None, filter=None)

Retrieves a list of managed instance groups that are contained within the specified project and zone.

listManagedInstances(project, zone, instanceGroupManager)

-

Lists managed instances.

+

Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.

list_next(previous_request, previous_response)

Retrieves the next page of results.

recreateInstances(project, zone, instanceGroupManager, body)

-

Recreates the specified instances. The instances are deleted, then recreated using the managed instance group's current instance template.

+

Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.

resize(project, zone, instanceGroupManager, size)

-

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group removes instances in the order that is outlined in Resizing a managed instance group.

+

Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.

setInstanceTemplate(project, zone, instanceGroupManager, body)

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.

setTargetPools(project, zone, instanceGroupManager, body)

-

Modifies the target pools to which all new instances in this group are assigned. The target pools for existing instances in the group do not change unless you recreate them.

+

Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.

Method Details

abandonInstances(project, zone, instanceGroupManager, body) -
Removes the specified instances from the managed instance group, and from any target pools where they are a member. The instances are not deleted. The managed instance group automatically reduces its targetSize value by the number of instances that you abandon from the group.
+  
Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # The names of instances to abandon from the managed instance group.
+    "instances": [ # The URL for one or more instances to abandon from the managed instance group.
       "A String",
     ],
   }
@@ -139,35 +139,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -177,78 +179,87 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of managed instance groups, and groups them by project and zone.
+  
Retrieves the list of managed instance groups and groups them by zone.
 
 Args:
-  project: string, The project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
-    "items": { # A map of filtered managed instance group lists.
-      "a_key": { # The name of the scope that contains this set of managed instance groups.
+    "nextPageToken": "A String", # [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.
+    "items": { # [Output Only] A map of filtered managed instance group lists.
+      "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
         "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
         "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
-          { # InstanceGroupManagers
-                #
-                # Next available tag: 19
-              "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
-                "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
+          {
+              "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+                "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
                 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
-                "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
+                "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create one of these instances, it tries again until it creates the instance successfully.
                 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
-                "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+                "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
                 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
                 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
               },
-              "description": "A String", # An optional text description for the managed instance group.
-              "zone": "A String", # The URL of the zone where the managed instance group is located.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+              "zone": "A String", # The name of the zone where the managed instance group is located.
               "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
-              "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
+              "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
               "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
-              "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
+              "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
                 "A String",
               ],
               "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
-              "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
+              "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
               "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+              "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+                { # The named port. For example: .
+                  "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+                  "port": 42, # The port number, which can be a value between 1 and 65535.
+                },
+              ],
               "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
-              "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
-              "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
+              "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+              "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
               "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
             },
         ],
       },
     },
-    "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] Type of the resource. Always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
-    "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server defines this identifier.
-    "selfLink": "A String", # [Output Only] The URL for this aggregated list of managed instance groups. The server defines this URL.
+    "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
+    "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
+    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
   }
@@ -268,46 +279,48 @@

Method Details

delete(project, zone, instanceGroupManager) -
Deletes the specified managed instance group resource.
+  
Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read  Deleting an instance group for more information.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager to delete. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -317,25 +330,25 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
deleteInstances(project, zone, instanceGroupManager, body) -
Deletes the specified instances. The instances are deleted and removed from the instance group and any target pools where they are a member. The managed instance group automatically reduces its targetSize value by the number of instances that you delete.
+  
Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # The names of one or more instances to delete.
+    "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
       "A String",
     ],
   }
@@ -345,35 +358,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -383,90 +398,98 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, zone, instanceGroupManager) -
Returns the specified managed instance group resource.
+  
Returns all of the details about the specified managed instance group.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager resource. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
 
 Returns:
   An object of the form:
 
-    { # InstanceGroupManagers
-        #
-        # Next available tag: 19
-      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
-        "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
+    {
+      "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+        "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
         "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
-        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
+        "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create one of these instances, it tries again until it creates the instance successfully.
         "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
-        "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+        "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
         "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
         "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
       },
-      "description": "A String", # An optional text description for the managed instance group.
-      "zone": "A String", # The URL of the zone where the managed instance group is located.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "zone": "A String", # The name of the zone where the managed instance group is located.
       "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
-      "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
+      "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
       "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
-      "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
+      "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
         "A String",
       ],
       "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
-      "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
+      "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
       "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+      "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+        { # The named port. For example: .
+          "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+          "port": 42, # The port number, which can be a value between 1 and 65535.
+        },
+      ],
       "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
-      "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
-      "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
+      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+      "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
       "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
     }
insert(project, zone, body) -
Creates a managed instance group resource in the specified project using the data that is included in the request.
+  
Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where you want to create the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # InstanceGroupManagers
-      # 
-      # Next available tag: 19
-    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
-      "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
+{
+    "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+      "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
       "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
-      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
+      "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create one of these instances, it tries again until it creates the instance successfully.
       "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
-      "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+      "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
       "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
       "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
     },
-    "description": "A String", # An optional text description for the managed instance group.
-    "zone": "A String", # The URL of the zone where the managed instance group is located.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "zone": "A String", # The name of the zone where the managed instance group is located.
     "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
-    "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
+    "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
     "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
-    "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
+    "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
       "A String",
     ],
     "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
-    "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
+    "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
     "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+    "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+      { # The named port. For example: .
+        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+        "port": 42, # The port number, which can be a value between 1 and 65535.
+      },
+    ],
     "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
-    "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
-    "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
+    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
     "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
   }
 
@@ -475,35 +498,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -513,9 +538,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -524,76 +549,92 @@

Method Details

Retrieves a list of managed instance groups that are contained within the specified project and zone.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
-    { # [Output Only] A list of InstanceGroupManager resources.
-    "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
-    "items": [ # [Output Only] A list of managed instance group resources.
-      { # InstanceGroupManagers
-            #
-            # Next available tag: 19
-          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
-            "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
+    { # [Output Only] A list of managed instance groups.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of managed instance groups.
+      {
+          "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
+            "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
             "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
-            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
+            "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create one of these instances, it tries again until it creates the instance successfully.
             "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
-            "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
+            "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
             "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
             "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
           },
-          "description": "A String", # An optional text description for the managed instance group.
-          "zone": "A String", # The URL of the zone where the managed instance group is located.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "zone": "A String", # The name of the zone where the managed instance group is located.
           "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
-          "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
+          "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
           "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
-          "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
+          "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
             "A String",
           ],
           "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
-          "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
+          "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
           "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
+          "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
+            { # The named port. For example: .
+              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
+              "port": 42, # The port number, which can be a value between 1 and 65535.
+            },
+          ],
           "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
-          "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
-          "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
+          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+          "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
           "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
         },
     ],
-    "kind": "compute#instanceGroupManagerList", # [Output Only] Type of the resource. Always compute#instanceGroupManagerList for a list of managed instance group resources.
-    "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
-    "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
+    "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
+    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
   }
listManagedInstances(project, zone, instanceGroupManager) -
Lists managed instances.
+  
Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
   instanceGroupManager: string, The name of the managed instance group. (required)
 
 Returns:
   An object of the form:
 
     {
-    "managedInstances": [ # List of managed instances. If empty - all instances are listed.
+    "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
       {
-        "currentAction": "A String", # The current action that the managed instance group has scheduled for the instance.
-        "instance": "A String", # The URL of the instance (set even though instance does not exist yet).
-        "lastAttempt": { # Information about the last attempt to create or delete the instance.
-          "errors": { # Encountered errors during the last attempt to create or delete the instance.
+        "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+            # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+            # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+            # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's target_size value is decreased.
+            # - RECREATING The managed instance group is recreating this instance.
+            # - DELETING The managed instance group is permanently deleting this instance.
+            # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+            # - RESTARTING The managed instance group is restarting the instance.
+            # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
+        "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+        "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
+          "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
             "errors": [ # [Output Only] The array of errors encountered while processing this operation.
               {
                 "message": "A String", # [Output Only] An optional, human-readable error message.
@@ -603,8 +644,8 @@ 

Method Details

], }, }, - "id": "A String", # The unique identifier for this resource (empty when instance does not exist). - "instanceStatus": "A String", # The status of the instance (empty when instance does not exist). + "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist. + "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist. }, ], }
@@ -626,17 +667,17 @@

Method Details

recreateInstances(project, zone, instanceGroupManager, body) -
Recreates the specified instances. The instances are deleted, then recreated using the managed instance group's current instance template.
+  
Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # The names of one or more instances to recreate.
+    "instances": [ # The URL for one or more instances to recreate.
       "A String",
     ],
   }
@@ -646,35 +687,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -684,55 +727,57 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
resize(project, zone, instanceGroupManager, size) -
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group removes instances in the order that is outlined in Resizing a managed instance group.
+  
Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -742,9 +787,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -753,9 +798,9 @@

Method Details

Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
@@ -768,35 +813,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -806,28 +853,28 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
setTargetPools(project, zone, instanceGroupManager, body) -
Modifies the target pools to which all new instances in this group are assigned. The target pools for existing instances in the group do not change unless you recreate them.
+  
Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the managed instance group is located. (required)
-  instanceGroupManager: string, The name of the instance group manager. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the managed instance group is located. (required)
+  instanceGroupManager: string, The name of the managed instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. When the managed instance group creates new instances, the group automatically adds those instances to the target pools that are specified in this parameter. Changing the value of this parameter does not change the target pools of existing instances in this managed instance group.
+    "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
       "A String",
     ],
-    "fingerprint": "A String", # The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
+    "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
   }
 
 
@@ -835,35 +882,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -873,9 +922,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.instanceGroups.html b/docs/dyn/compute_v1.instanceGroups.html index ec3a1156693..de4935eb9fb 100644 --- a/docs/dyn/compute_v1.instanceGroups.html +++ b/docs/dyn/compute_v1.instanceGroups.html @@ -76,16 +76,16 @@

Compute Engine API . addInstances(project, zone, instanceGroup, body)

-

Adds a list of instances to an instance group. All of the instances in the instance group must be in the same network.

+

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of instance groups, and sorts them by zone.

+

Retrieves the list of instance groups and sorts them by zone.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, zone, instanceGroup)

-

Deletes the specified instance group.

+

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

get(project, zone, instanceGroup)

Returns the specified instance group resource.

@@ -97,7 +97,7 @@

Instance Methods

Retrieves the list of instance groups that are located in the specified project and zone.

listInstances(project, zone, instanceGroup, body, maxResults=None, pageToken=None, filter=None)

-

Lists instances in an instance group. The parameters for this method specify whether the list filters instances by state and named ports information.

+

Lists the instances in the specified instance group.

listInstances_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -106,26 +106,26 @@

Instance Methods

Retrieves the next page of results.

removeInstances(project, zone, instanceGroup, body)

-

Removes a list of instances from an instance group.

+

Removes one or more instances from the specified instance group, but does not delete those instances.

setNamedPorts(project, zone, instanceGroup, body)

-

Sets the named ports in an instance group.

+

Sets the named ports for the specified instance group.

Method Details

addInstances(project, zone, instanceGroup, body) -
Adds a list of instances to an instance group. All of the instances in the instance group must be in the same network.
+  
Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read  Adding instances for more information.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group where you are adding instances. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # The instances to add to the instance group.
+    "instances": [ # The list of instances to add to the instance group.
       {
-        "instance": "A String",
+        "instance": "A String", # The URL for a specific instance.
       },
     ],
   }
@@ -135,35 +135,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -173,40 +175,45 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of instance groups, and sorts them by zone.
+  
Retrieves the list of instance groups and sorts them by zone.
 
 Args:
-  project: string, The project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # A map of scoped instance group lists.
       "a_key": { # The name of the scope that contains this set of instance groups.
         "warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
@@ -214,27 +221,32 @@ 

Method Details

{ "size": 42, # [Output Only] The total number of instances in the instance group. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. - "description": "A String", # An optional text description for the instance group. - "zone": "A String", # The URL of the zone where the instance group is located. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "zone": "A String", # [Output Only] The URL of the zone where the instance group is located. "network": "A String", # The URL of the network to which all instances in the instance group belong. - "fingerprint": "A String", # [Output Only] The fingerprint of the named ports information. The system uses this fingerprint to detect conflicts when multiple users change the named ports information concurrently. - "namedPorts": [ # Assigns a name to a port number. For example: {name: ?http?, port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: ?http?, port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. - { # The named port information. For example: . - "name": "A String", # The name for this NamedPort. + "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. + "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. + "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} + # + # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] + # + # Named ports apply to all instances in this instance group. + { # The named port. For example: . + "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. }, ], "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. - "id": "A String", # [Output Only] A unique identifier for this instance group. The server defines this identifier. - "selfLink": "A String", # [Output Only] The URL for this instance group. The server defines this URL. + "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. }, ], }, }, "kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. - "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server defines this identifier. - "selfLink": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server defines this identifier. + "id": "A String", # [Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier. + "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL. }
@@ -254,46 +266,48 @@

Method Details

delete(project, zone, instanceGroup) -
Deletes the specified instance group.
+  
Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read  Deleting an instance group for more information.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -303,9 +317,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -314,8 +328,8 @@

Method Details

Returns the specified instance group resource.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group. (required)
 
 Returns:
@@ -324,19 +338,24 @@ 

Method Details

{ "size": 42, # [Output Only] The total number of instances in the instance group. "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups. - "description": "A String", # An optional text description for the instance group. - "zone": "A String", # The URL of the zone where the instance group is located. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "zone": "A String", # [Output Only] The URL of the zone where the instance group is located. "network": "A String", # The URL of the network to which all instances in the instance group belong. - "fingerprint": "A String", # [Output Only] The fingerprint of the named ports information. The system uses this fingerprint to detect conflicts when multiple users change the named ports information concurrently. - "namedPorts": [ # Assigns a name to a port number. For example: {name: ?http?, port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: ?http?, port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group. - { # The named port information. For example: . - "name": "A String", # The name for this NamedPort. + "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. + "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong. + "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80} + # + # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] + # + # Named ports apply to all instances in this instance group. + { # The named port. For example: . + "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. }, ], "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format. - "id": "A String", # [Output Only] A unique identifier for this instance group. The server defines this identifier. - "selfLink": "A String", # [Output Only] The URL for this instance group. The server defines this URL. + "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier. + "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL. "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. }
@@ -346,27 +365,32 @@

Method Details

Creates an instance group in the specified project using the parameters that are included in the request.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where you want to create the instance group. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "size": 42, # [Output Only] The total number of instances in the instance group.
     "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
-    "description": "A String", # An optional text description for the instance group.
-    "zone": "A String", # The URL of the zone where the instance group is located.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "zone": "A String", # [Output Only] The URL of the zone where the instance group is located.
     "network": "A String", # The URL of the network to which all instances in the instance group belong.
-    "fingerprint": "A String", # [Output Only] The fingerprint of the named ports information. The system uses this fingerprint to detect conflicts when multiple users change the named ports information concurrently.
-    "namedPorts": [ # Assigns a name to a port number. For example: {name: ?http?, port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: ?http?, port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
-      { # The named port information. For example: .
-        "name": "A String", # The name for this NamedPort.
+    "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+    "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+    "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+        # 
+        # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+        # 
+        # Named ports apply to all instances in this instance group.
+      { # The named port. For example: .
+        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
         "port": 42, # The port number, which can be a value between 1 and 65535.
       },
     ],
     "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
-    "id": "A String", # [Output Only] A unique identifier for this instance group. The server defines this identifier.
-    "selfLink": "A String", # [Output Only] The URL for this instance group. The server defines this URL.
+    "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+    "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
     "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
   }
 
@@ -375,35 +399,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -413,9 +439,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -424,54 +450,63 @@

Method Details

Retrieves the list of instance groups that are located in the specified project and zone.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # A list of InstanceGroup resources.
-    "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
-    "items": [ # A list of InstanceGroup resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # A list of instance groups.
       {
           "size": 42, # [Output Only] The total number of instances in the instance group.
           "kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
-          "description": "A String", # An optional text description for the instance group.
-          "zone": "A String", # The URL of the zone where the instance group is located.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "zone": "A String", # [Output Only] The URL of the zone where the instance group is located.
           "network": "A String", # The URL of the network to which all instances in the instance group belong.
-          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports information. The system uses this fingerprint to detect conflicts when multiple users change the named ports information concurrently.
-          "namedPorts": [ # Assigns a name to a port number. For example: {name: ?http?, port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: ?http?, port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
-            { # The named port information. For example: .
-              "name": "A String", # The name for this NamedPort.
+          "fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
+          "subnetwork": "A String", # The URL of the subnetwork to which all instances in the instance group belong.
+          "namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
+              #
+              # This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
+              #
+              # Named ports apply to all instances in this instance group.
+            { # The named port. For example: .
+              "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
               "port": 42, # The port number, which can be a value between 1 and 65535.
             },
           ],
           "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
-          "id": "A String", # [Output Only] A unique identifier for this instance group. The server defines this identifier.
-          "selfLink": "A String", # [Output Only] The URL for this instance group. The server defines this URL.
+          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+          "selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
           "name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
         },
     ],
     "kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
-    "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server defines this identifier.
-    "selfLink": "A String", # [Output Only] The URL for this instance group. The server defines this URL.
+    "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier.
+    "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
   }
listInstances(project, zone, instanceGroup, body, maxResults=None, pageToken=None, filter=None) -
Lists instances in an instance group. The parameters for this method specify whether the list filters instances by state and named ports information.
+  
Lists the instances in the specified instance group.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
   body: object, The request body. (required)
     The object takes the form of:
@@ -480,34 +515,38 @@ 

Method Details

"instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. } - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. + +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. + +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +Compute 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. -For example, filter=name ne example-instance. +The 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. Returns: An object of the form: { - "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request. - "items": [ # A list of InstanceWithNamedPorts resources, which contains all named ports for the given instance. + "nextPageToken": "A String", # [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. + "items": [ # [Output Only] A list of instances and any named ports that are assigned to those instances. { - "status": "A String", # The status of the instance. - "instance": "A String", # The URL of the instance. - "namedPorts": [ # The named ports that belong to this instance group. - { # The named port information. For example: . - "name": "A String", # The name for this NamedPort. + "status": "A String", # [Output Only] The status of the instance. + "instance": "A String", # [Output Only] The URL of the instance. + "namedPorts": [ # [Output Only] The named ports that belong to this instance group. + { # The named port. For example: . + "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. "port": 42, # The port number, which can be a value between 1 and 65535. }, ], }, ], "kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for lists of instance groups. - "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server defines this identifier. - "selfLink": "A String", # [Output Only] The URL for this list of instance groups. The server defines this URL. + "id": "A String", # [Output Only] A unique identifier for this list of instance groups. The server generates this identifier. + "selfLink": "A String", # [Output Only] The URL for this list of instance groups. The server generates this URL. }
@@ -541,19 +580,19 @@

Method Details

removeInstances(project, zone, instanceGroup, body) -
Removes a list of instances from an instance group.
+  
Removes one or more instances from the specified instance group, but does not delete those instances.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # The instances to remove from the instance group.
+    "instances": [ # The list of instances to remove from the instance group.
       {
-        "instance": "A String",
+        "instance": "A String", # The URL for a specific instance.
       },
     ],
   }
@@ -563,35 +602,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -601,31 +642,31 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
setNamedPorts(project, zone, instanceGroup, body) -
Sets the named ports in an instance group.
+  
Sets the named ports for the specified instance group.
 
 Args:
-  project: string, The project ID for this request. (required)
-  zone: string, The URL of the zone where the instance group is located. (required)
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone where the instance group is located. (required)
   instanceGroup: string, The name of the instance group where the named ports are updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "namedPorts": [ # The list of named ports to set for this instance group.
-      { # The named port information. For example: .
-        "name": "A String", # The name for this NamedPort.
+      { # The named port. For example: .
+        "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
         "port": 42, # The port number, which can be a value between 1 and 65535.
       },
     ],
-    "fingerprint": "A String", # The fingerprint of the named ports information, which is a hash of the contents. Use this field for optimistic locking when you update the named ports entries.
+    "fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
   }
 
 
@@ -633,35 +674,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -671,9 +714,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index dc399e9a225..6bb67779e43 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -76,13 +76,13 @@

Compute Engine API . delete(project, instanceTemplate)

-

Deletes the specified instance template.

+

Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.

get(project, instanceTemplate)

Returns the specified instance template resource.

insert(project, body)

-

Creates an instance template in the specified project using the data that is included in the request.

+

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

list(project, maxResults=None, pageToken=None, filter=None)

Retrieves a list of instance templates that are contained within the specified project and zone.

@@ -92,45 +92,47 @@

Instance Methods

Method Details

delete(project, instanceTemplate) -
Deletes the specified instance template.
+  
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.
 
 Args:
-  project: string, The project ID for this request. (required)
+  project: string, Project ID for this request. (required)
   instanceTemplate: string, The name of the instance template to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -140,9 +142,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -151,7 +153,7 @@

Method Details

Returns the specified instance template resource.
 
 Args:
-  project: string, The project ID for this request. (required)
+  project: string, Project ID for this request. (required)
   instanceTemplate: string, The name of the instance template. (required)
 
 Returns:
@@ -159,10 +161,10 @@ 

Method Details

{ # An Instance Template resource. "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. - "description": "A String", # An optional text description for the instance template. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format. - "properties": { # The instance properties for the instance template resource. + "properties": { # The instance properties for this instance template. "machineType": "A String", # The machine type to use for instances that are created from this template. "description": "A String", # An optional text description for the instances that are created from this instance template. "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. @@ -211,17 +213,17 @@

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "scheduling": { # Sets the scheduling options for an Instance. # A list of scheduling options for the instances that are created from this template. + "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false. + "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information. "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -240,7 +242,7 @@

Method Details

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and 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 metadata. }, - "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access. + "networkInterfaces": [ # An array of network access configurations for this interface. { # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. @@ -252,6 +254,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -264,25 +269,25 @@

Method Details

], }, "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. - "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
insert(project, body) -
Creates an instance template in the specified project using the data that is included in the request.
+  
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
 
 Args:
-  project: string, The project ID for this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # An Instance Template resource.
     "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
-    "description": "A String", # An optional text description for the instance template.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
     "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
-    "properties": { # The instance properties for the instance template resource.
+    "properties": { # The instance properties for this instance template.
       "machineType": "A String", # The machine type to use for instances that are created from this template.
       "description": "A String", # An optional text description for the instances that are created from this instance template.
       "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
@@ -331,17 +336,17 @@ 

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "scheduling": { # Sets the scheduling options for an Instance. # A list of scheduling options for the instances that are created from this template. + "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false. + "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information. "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -360,7 +365,7 @@

Method Details

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and 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 metadata. }, - "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access. + "networkInterfaces": [ # An array of network access configurations for this interface. { # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. @@ -372,6 +377,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -384,7 +392,7 @@

Method Details

], }, "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. - "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -392,35 +400,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -430,9 +440,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -441,27 +451,31 @@

Method Details

Retrieves a list of instance templates that are contained within the specified project and zone.
 
 Args:
-  project: string, The project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # A list of instance templates.
-    "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
-    "items": [ # A list of InstanceTemplate resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] list of InstanceTemplate resources.
       { # An Instance Template resource.
           "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
-          "description": "A String", # An optional text description for the instance template.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.
           "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.
-          "properties": { # The instance properties for the instance template resource.
+          "properties": { # The instance properties for this instance template.
             "machineType": "A String", # The machine type to use for instances that are created from this template.
             "description": "A String", # An optional text description for the instances that are created from this instance template.
             "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
@@ -510,17 +524,17 @@ 

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "scheduling": { # Sets the scheduling options for an Instance. # A list of scheduling options for the instances that are created from this template. + "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this template. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "canIpForward": True or False, # A boolean that specifies if instances created from this template can send packets with source IP addresses other than their own or receive packets with destination IP addresses other than their own. If you use these instances as an IP gateway or as the next-hop in a Route resource, specify true. Otherwise, specify false. + "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information. "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -539,7 +553,7 @@

Method Details

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and 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 metadata. }, - "networkInterfaces": [ # An array of network access configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only supported access configuration. If you do not specify any access configurations, the instances that are created from this template will have no external internet access. + "networkInterfaces": [ # An array of network access configurations for this interface. { # A network interface resource attached to an instance. "accessConfigs": [ # An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. @@ -551,6 +565,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -563,7 +580,7 @@

Method Details

], }, "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. - "name": "A String", # The name of the instance template. The name must be 1-63 characters long, and comply with RFC1035. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 36290bbf372..d162f526751 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -79,7 +79,7 @@

Instance Methods

Adds an access config to an instance's network interface.

aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

A description of how to use this function

+

Retrieves aggregated list of instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -88,7 +88,7 @@

Instance Methods

Attaches a Disk resource to an instance.

delete(project, zone, instance)

-

Deletes the specified Instance resource. For more information, see Shutting down an instance.

+

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.

deleteAccessConfig(project, zone, instance, accessConfig, networkInterface)

Deletes an access config from an instance's network interface.

@@ -97,7 +97,7 @@

Instance Methods

Detaches a disk from an instance.

get(project, zone, instance)

-

Returns the specified instance resource.

+

Returns the specified Instance resource.

getSerialPortOutput(project, zone, instance, port=None)

Returns the specified instance's serial port output.

@@ -106,7 +106,7 @@

Instance Methods

Creates an instance resource in the specified project using the data included in the request.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of instance resources contained within the specified zone.

+

Retrieves the list of instances contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -116,6 +116,9 @@

Instance Methods

setDiskAutoDelete(project, zone, instance, autoDelete, deviceName)

Sets the auto-delete flag for a disk attached to an instance.

+

+ setMachineType(project, zone, instance, body)

+

Changes the machine type for a stopped instance to the machine type specified in the request.

setMetadata(project, zone, instance, body)

Sets metadata for the specified instance to the data included in the request.

@@ -127,10 +130,10 @@

Instance Methods

Sets tags for the specified instance to the data included in the request.

start(project, zone, instance)

-

This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

+

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.

stop(project, zone, instance)

-

This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.

+

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Method Details

addAccessConfig(project, zone, instance, networkInterface, body) @@ -156,35 +159,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -194,40 +199,44 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
A description of how to use this function
+  
Retrieves aggregated list of instances.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped instance lists.
-      "a_key": { # Name of the scope containing this set of instances.
+      "a_key": { # [Output Only] Name of the scope containing this set of instances.
         "instances": [ # [Output Only] List of instances contained in this scope.
           { # An Instance resource.
             "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
             "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
             "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
             "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
-            "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+            "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
             "zone": "A String", # [Output Only] URL of the zone where the instance resides.
             "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
               "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -275,21 +284,29 @@ 

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url: + "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: + # + # zones/us-central1-f/machineTypes/n1-standard-1 + # + # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): # - # zones/zone/machineTypes/machine-type + # zones/zone/machineTypes/custom-CPUS-MEMORY + # + # For example: zones/us-central1-f/machineTypes/custom-4-5120 + # + # For a full list of restrictions, read the Specifications for custom machine types. "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -310,6 +327,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -321,8 +341,8 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. { @@ -336,20 +356,21 @@

Method Details

}, ], "warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -374,7 +395,7 @@

Method Details

Args: project: string, Project ID for this request. (required) zone: string, The name of the zone for this request. (required) - instance: string, Instance name. (required) + instance: string, The instance name for this request. (required) body: object, The request body. (required) The object takes the form of: @@ -415,7 +436,7 @@

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. } @@ -425,35 +446,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -463,15 +486,15 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
delete(project, zone, instance) -
Deletes the specified Instance resource. For more information, see Shutting down an instance.
+  
Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -482,35 +505,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -520,9 +545,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -541,35 +566,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -579,9 +606,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -599,35 +626,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -637,15 +666,15 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, zone, instance) -
Returns the specified instance resource.
+  
Returns the specified Instance resource.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -660,7 +689,7 @@ 

Method Details

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED. "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "zone": "A String", # [Output Only] URL of the zone where the instance resides. "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. @@ -708,21 +737,29 @@

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url: + "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: # - # zones/zone/machineTypes/machine-type + # zones/us-central1-f/machineTypes/n1-standard-1 + # + # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): + # + # zones/zone/machineTypes/custom-CPUS-MEMORY + # + # For example: zones/us-central1-f/machineTypes/custom-4-5120 + # + # For a full list of restrictions, read the Specifications for custom machine types. "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -743,6 +780,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -754,8 +794,8 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. { @@ -784,7 +824,7 @@

Method Details

{ # An instance's serial console output. "kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "contents": "A String", # [Output Only] The contents of the console output. }
@@ -804,7 +844,7 @@

Method Details

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED. "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances. "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "zone": "A String", # [Output Only] URL of the zone where the instance resides. "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. @@ -852,21 +892,29 @@

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url: + "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: + # + # zones/us-central1-f/machineTypes/n1-standard-1 + # + # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): + # + # zones/zone/machineTypes/custom-CPUS-MEMORY # - # zones/zone/machineTypes/machine-type + # For example: zones/us-central1-f/machineTypes/custom-4-5120 + # + # For a full list of restrictions, read the Specifications for custom machine types. "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -887,6 +935,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -898,8 +949,8 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. { @@ -917,35 +968,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -955,39 +1008,43 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of instance resources contained within the specified zone.
+  
Retrieves the list of instances contained within the specified zone.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of instance resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # [Output Only] A list of Instance resources.
+    { # Contains a list of instances.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of instances.
       { # An Instance resource.
         "cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.
         "status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
         "kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.
         "canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.
-        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         "zone": "A String", # [Output Only] URL of the zone where the instance resides.
         "tags": { # A set of instance tags. # A list of tags to appy to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
           "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
@@ -1035,21 +1092,29 @@ 

Method Details

"A String", ], "mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. - "interface": "A String", + "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. }, ], - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status. "scheduling": { # Sets the scheduling options for an Instance. # Scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. }, - "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance. This is provided by the client when the instance is created. For example, the following is a valid partial url: + "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: + # + # zones/us-central1-f/machineTypes/n1-standard-1 # - # zones/zone/machineTypes/machine-type + # To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): + # + # zones/zone/machineTypes/custom-CPUS-MEMORY + # + # For example: zones/us-central1-f/machineTypes/custom-4-5120 + # + # For a full list of restrictions, read the Specifications for custom machine types. "serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information. { # A service account. "scopes": [ # The list of scopes to be made available for this service account. @@ -1070,6 +1135,9 @@

Method Details

], "networkIP": "A String", # [Output Only] An optional IPV4 internal network address assigned to the instance for this network interface. "name": "A String", # [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc. + "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/subnetworks/subnetwork + # - zones/zone/subnetworks/subnetwork "network": "A String", # URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used: # # global/networks/default @@ -1081,8 +1149,8 @@

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. "metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. { @@ -1096,8 +1164,8 @@

Method Details

}, ], "kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server defined URL for this resource. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -1128,35 +1196,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1166,9 +1236,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -1187,35 +1257,103 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. + "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. + "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + { + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } + { + "value": "A String", # [Output Only] A warning data value corresponding to the key. + "key": "A String", # [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). + }, + ], + }, + ], + "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. + "name": "A String", # [Output Only] Name of the resource. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. + "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this operation. + { + "message": "A String", # [Output Only] An optional, human-readable error message. + "code": "A String", # [Output Only] The error type identifier for this error. + "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. + }, + ], + }, + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. + } + + +
+ setMachineType(project, zone, instance, body) +
Changes the machine type for a stopped instance to the machine type specified in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instance: string, Name of the instance scoping this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -1225,9 +1363,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -1258,35 +1396,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1296,9 +1436,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -1316,7 +1456,7 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. "preemptible": True or False, # Whether the instance is preemptible. - "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting maintenance behavior. + "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. } @@ -1324,35 +1464,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1362,9 +1504,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -1393,35 +1535,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1431,15 +1575,15 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
start(project, zone, instance) -
This method starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
+  
Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -1450,35 +1594,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1488,15 +1634,15 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
stop(project, zone, instance) -
This method stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses,will continue to be charged until they are deleted. For more information, see Stopping an instance.
+  
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -1507,35 +1653,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -1545,9 +1693,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.licenses.html b/docs/dyn/compute_v1.licenses.html index ca2453b9459..850310db915 100644 --- a/docs/dyn/compute_v1.licenses.html +++ b/docs/dyn/compute_v1.licenses.html @@ -84,13 +84,13 @@

Method Details

Args: project: string, Project ID for this request. (required) - license: string, Name of the license resource to return. (required) + license: string, Name of the License resource to return. (required) Returns: An object of the form: { # A license resource. - "chargesUseFee": True or False, # If true, the customer will be charged license fee for running software that contains this license on an instance. + "chargesUseFee": True or False, # [Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance. "kind": "compute#license", # [Output Only] Type of resource. Always compute#license for licenses. "name": "A String", # [Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_v1.machineTypes.html b/docs/dyn/compute_v1.machineTypes.html index 73e8d1f7d2c..bcea9dab21d 100644 --- a/docs/dyn/compute_v1.machineTypes.html +++ b/docs/dyn/compute_v1.machineTypes.html @@ -76,46 +76,50 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of machine type resources grouped by scope.

+

Retrieves an aggregated list of machine types.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

get(project, zone, machineType)

-

Returns the specified machine type resource.

+

Returns the specified machine type.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of machine type resources available to the specified project.

+

Retrieves a list of machine types available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of machine type resources grouped by scope.
+  
Retrieves an aggregated list of machine types.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped machine type lists.
       "a_key": { # [Output Only] Name of the scope containing this set of machine types.
         "machineTypes": [ # [Output Only] List of machine types contained in this scope.
           { # A Machine Type resource.
-            "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+            "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
             "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
-            "kind": "compute#machineType", # Type of the resource.
+            "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
             "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
             "description": "A String", # [Output Only] An optional textual description of the resource.
             "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
@@ -134,25 +138,26 @@ 

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, ], "warning": { # [Output Only] An informational warning that appears when the machine types list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -173,20 +178,20 @@

Method Details

get(project, zone, machineType) -
Returns the specified machine type resource.
+  
Returns the specified machine type.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  machineType: string, Name of the machine type resource to return. (required)
+  machineType: string, Name of the machine type to return. (required)
 
 Returns:
   An object of the form:
 
     { # A Machine Type resource.
-    "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+    "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
     "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
-    "kind": "compute#machineType", # Type of the resource.
+    "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
     "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
     "description": "A String", # [Output Only] An optional textual description of the resource.
     "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
@@ -205,7 +210,7 @@ 

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }
@@ -213,29 +218,33 @@

Method Details

list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of machine type resources available to the specified project.
+  
Retrieves a list of machine types available to the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
   zone: string, The name of the zone for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of Machine Type resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    { # Contains a list of machine types.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of Machine Type resources.
       { # A Machine Type resource.
-        "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
+        "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
         "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
-        "kind": "compute#machineType", # Type of the resource.
+        "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
         "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
         "description": "A String", # [Output Only] An optional textual description of the resource.
         "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
@@ -254,13 +263,13 @@ 

Method Details

}, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, ], "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index 15e9937afa5..594ecc22e8f 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -76,61 +76,63 @@

Compute Engine API . delete(project, network)

-

Deletes the specified network resource.

+

Deletes the specified network.

get(project, network)

-

Returns the specified network resource.

+

Returns the specified network.

insert(project, body)

-

Creates a network resource in the specified project using the data included in the request.

+

Creates a network in the specified project using the data included in the request.

list(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of network resources available to the specified project.

+

Retrieves the list of networks available to the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(project, network) -
Deletes the specified network resource.
+  
Deletes the specified network.
 
 Args:
   project: string, Project ID for this request. (required)
-  network: string, Name of the network resource to delete. (required)
+  network: string, Name of the network to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -140,30 +142,36 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, network) -
Returns the specified network resource.
+  
Returns the specified network.
 
 Args:
   project: string, Project ID for this request. (required)
-  network: string, Name of the network resource to return. (required)
+  network: string, Name of the network to return. (required)
 
 Returns:
   An object of the form:
 
-    { # A network resource.
+    { # Represents a Network resource. Read Networks and Firewalls for more information.
       "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
-      "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+        "A String",
+      ],
+      "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+          #
+          # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
       "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
       "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -171,20 +179,26 @@

Method Details

insert(project, body) -
Creates a network resource in the specified project using the data included in the request.
+  
Creates a network in the specified project using the data included in the request.
 
 Args:
   project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A network resource.
+{ # Represents a Network resource. Read Networks and Firewalls for more information.
     "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+      "A String",
+    ],
+    "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+        # 
+        # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
     "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
     "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -194,35 +208,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -232,45 +248,55 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of network resources available to the specified project.
+  
Retrieves the list of networks available to the specified project.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
-    { # Contains a list of Network resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    { # Contains a list of networks.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of Network resources.
-      { # A network resource.
+      { # Represents a Network resource. Read Networks and Firewalls for more information.
           "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.
+            "A String",
+          ],
+          "autoCreateSubnetworks": True or False, # When set to true, the network is created in "auto subnet mode". When set to false, the network is in "custom subnet mode".
+              #
+              # In "auto subnet mode", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region.
           "IPv4Range": "A String", # The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.
           "gatewayIPv4": "A String", # A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource .
   }
diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html index 26f5d52a9b6..72ca1573f73 100644 --- a/docs/dyn/compute_v1.projects.html +++ b/docs/dyn/compute_v1.projects.html @@ -100,7 +100,7 @@

Method Details

Returns: An object of the form: - { # A Project resource. Projects can only be created in the Google Developers Console. Unless marked otherwise, values can only be modified in the console. + { # A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console. "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects. "enabledFeatures": [ # Restricted features enabled for use on this project. "A String", @@ -122,13 +122,13 @@

Method Details

"limit": 3.14, # [Output Only] Quota limit for this metric. }, ], - "name": "A String", # Name of the resource. - "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The location in Cloud Storage and naming method of the daily usage report. - "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it. + "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. + "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. + "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. }, "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "description": "A String", # An optional textual description of the resource. }
@@ -148,7 +148,7 @@

Method Details

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk # - projects/project/zones/zone/disks/disk # - zones/zone/disks/disk - "destinationZone": "A String", # The URL of the destination zone to move the disk to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: + "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone # - projects/project/zones/zone # - zones/zone @@ -159,35 +159,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -197,9 +199,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -217,7 +219,7 @@

Method Details

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance # - projects/project/zones/zone/instances/instance # - zones/zone/instances/instance - "destinationZone": "A String", # The URL of the destination zone to move the instance to. This can be a full or partial URL. For example, the following are all valid URLs to a zone: + "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: # - https://www.googleapis.com/compute/v1/projects/project/zones/zone # - projects/project/zones/zone # - zones/zone @@ -228,35 +230,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -266,9 +270,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -297,35 +301,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -335,9 +341,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -351,7 +357,7 @@

Method Details

The object takes the form of: { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. - "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This is just the bucket name, with no gs:// or https://storage.googleapis.com/ in front of it. + "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. } @@ -360,35 +366,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -398,9 +406,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } diff --git a/docs/dyn/compute_v1.regionOperations.html b/docs/dyn/compute_v1.regionOperations.html index a9adbb9cd68..82e0ca9e1cb 100644 --- a/docs/dyn/compute_v1.regionOperations.html +++ b/docs/dyn/compute_v1.regionOperations.html @@ -82,7 +82,7 @@

Instance Methods

Retrieves the specified region-specific Operations resource.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of Operation resources contained within the specified region.

+

Retrieves a list of Operation resources contained within the specified region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -93,7 +93,7 @@

Method Details

Args: project: string, Project ID for this request. (required) - region: string, Name of the region scoping this request. (required) + region: string, Name of the region for this request. (required) operation: string, Name of the Operations resource to delete. (required) @@ -104,42 +104,44 @@

Method Details

Args: project: string, Project ID for this request. (required) - region: string, Name of the zone scoping this request. (required) + region: string, Name of the region for this request. (required) operation: string, Name of the Operations resource to return. (required) Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -149,63 +151,69 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of Operation resources contained within the specified region.
+  
Retrieves a list of Operation resources contained within the specified region.
 
 Args:
   project: string, Project ID for this request. (required)
-  region: string, Name of the region scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  region: string, Name of the region for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of Operation resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
-    "items": [ # [Output Only] The Operation resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Operation resources.
       { # An Operation resource, used to manage asynchronous API requests.
-        "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-        "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+        "clientOperationId": "A String", # [Output Only] Reserved for future use.
         "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-        "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-        "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
         "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-        "progress": 42, # [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.
-        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+        "progress": 42, # [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.
+        "httpErrorStatusCode": 42, # [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.
         "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
         "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
           {
-            "message": "A String", # [Output Only] Optional human-readable details for this warning.
-            "code": "A String", # [Output Only] The warning type identifier for this warning.
-            "data": [ # [Output Only] Metadata for this warning in key: value format.
+            "message": "A String", # [Output Only] A human-readable description of the warning code.
+            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
               {
                 "value": "A String", # [Output Only] A warning data value corresponding to the key.
-                "key": "A String", # [Output Only] A key for the warning data.
+                "key": "A String", # [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).
               },
             ],
           },
         ],
         "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
         "name": "A String", # [Output Only] Name of the resource.
-        "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
         "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
           "errors": [ # [Output Only] The array of errors encountered while processing this operation.
             {
@@ -215,13 +223,13 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, ], "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html index b51e25f20df..b1edebf3ca0 100644 --- a/docs/dyn/compute_v1.regions.html +++ b/docs/dyn/compute_v1.regions.html @@ -117,7 +117,7 @@

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server . + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. } @@ -129,19 +129,23 @@

Method Details

Args: project: string, Project ID for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: { # Contains a list of region resources. - "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. + "nextPageToken": "A String", # [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. "items": [ # [Output Only] A list of Region resources. { # Region resource. "status": "A String", # [Output Only] Status of the region, either UP or DOWN. @@ -165,13 +169,13 @@

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server . + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, ], "kind": "compute#regionList", # [Output Only] Type of resource. Always compute#regionList for lists of regions. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. } diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html index ecb577bfff6..d58038bf104 100644 --- a/docs/dyn/compute_v1.routes.html +++ b/docs/dyn/compute_v1.routes.html @@ -95,42 +95,44 @@

Method Details

Deletes the specified route resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   route: string, Name of the route resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -140,9 +142,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -151,43 +153,48 @@

Method Details

Returns the specified route resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   route: string, Name of the route resource to return. (required)
 
 Returns:
   An object of the form:
 
-    { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
-      "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway:  projects//global/gateways/default-internet-gateway
+    { # Represents a Routes resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+        #
+        # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+        #
+        # Packets that do not match any route in the sending instance's routing table are dropped.
+      "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
       "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
       "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
       "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
       "tags": [ # A list of instance tags to which this route applies.
         "A String",
       ],
-      "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
+      "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
           # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
-      "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+      "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
       "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
       "network": "A String", # Fully-qualified URL of the network that this route applies to.
       "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
       "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
         {
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
       ],
       "destRange": "A String", # The destination range of outgoing packets that this route applies to.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
-      "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     }
@@ -196,41 +203,46 @@

Method Details

Creates a route resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
-    "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway:  projects//global/gateways/default-internet-gateway
+{ # Represents a Routes resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+      # 
+      # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+      # 
+      # Packets that do not match any route in the sending instance's routing table are dropped.
+    "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
     "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
     "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     "tags": [ # A list of instance tags to which this route applies.
       "A String",
     ],
-    "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
+    "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
         # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
-    "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+    "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
     "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
     "network": "A String", # Fully-qualified URL of the network that this route applies to.
     "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
     "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "destRange": "A String", # The destination range of outgoing packets that this route applies to.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
   }
 
 
@@ -238,35 +250,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -276,9 +290,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -287,52 +301,61 @@

Method Details

Retrieves the list of route resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of route resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # A list of Route resources.
-      { # The route resource. A Route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with instances by tag and the set of Routes for a particular instance is called its routing table. For each packet leaving a instance, the system searches that instance's routing table for a single best matching Route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the Route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning Route -- either to another instance destination, a instance gateway or a Google Compute Engien-operated gateway. Packets that do not match any Route in the sending instance's routing table are dropped.
-          "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. Currently, this is only the internet gateway:  projects//global/gateways/default-internet-gateway
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Route resources.
+      { # Represents a Routes resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.
+            #
+            # For each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching Routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.
+            #
+            # Packets that do not match any route in the sending instance's routing table are dropped.
+          "nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL:  projects//global/gateways/default-internet-gateway
           "nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.
           "kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
           "tags": [ # A list of instance tags to which this route applies.
             "A String",
           ],
-          "nextHopInstance": "A String", # The fully-qualified URL to an instance that should handle matching packets. For example:
+          "nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:
               # https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
-          "priority": 42, # Breaks ties between Routes of equal specificity. Routes with smaller values win when tied with routes with larger values. Default value is 1000. A valid range is between 0 and 65535.
+          "priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.
           "nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.
           "network": "A String", # Fully-qualified URL of the network that this route applies to.
           "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
           "warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.
             {
-              "message": "A String", # [Output Only] Optional human-readable details for this warning.
-              "code": "A String", # [Output Only] The warning type identifier for this warning.
-              "data": [ # [Output Only] Metadata for this warning in key: value format.
+              "message": "A String", # [Output Only] A human-readable description of the warning code.
+              "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+              "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                  # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
                 {
                   "value": "A String", # [Output Only] A warning data value corresponding to the key.
-                  "key": "A String", # [Output Only] A key for the warning data.
+                  "key": "A String", # [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).
                 },
               ],
             },
           ],
           "destRange": "A String", # The destination range of outgoing packets that this route applies to.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "nextHopIp": "A String", # The network IP address of an instance that should handle matching packets.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         },
     ],
     "kind": "compute#routeList", # Type of resource.
diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html
index 12834f2552a..b0800481ddf 100644
--- a/docs/dyn/compute_v1.snapshots.html
+++ b/docs/dyn/compute_v1.snapshots.html
@@ -94,42 +94,44 @@ 

Method Details

For more information, see Deleting snaphots. Args: - project: string, Name of the project scoping this request. (required) + project: string, Project ID for this request. (required) snapshot: string, Name of the Snapshot resource to delete. (required) Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -139,9 +141,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -150,26 +152,26 @@

Method Details

Returns the specified Snapshot resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   snapshot: string, Name of the Snapshot resource to return. (required)
 
 Returns:
   An object of the form:
 
     { # A persistent disk snapshot resource.
-      "status": "A String", # [Output Only] The status of the snapshot.
+      "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
       "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
       "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
-      "sourceDisk": "A String", # The source disk used to create this snapshot.
-      "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+      "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
       "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
       "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB.
-      "licenses": [ # Public visible licenses.
+      "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
         "A String",
       ],
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -180,41 +182,45 @@

Method Details

Retrieves the list of Snapshot resources contained within the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of Snapshot resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": [ # A list of Snapshot resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Snapshot resources.
       { # A persistent disk snapshot resource.
-          "status": "A String", # [Output Only] The status of the snapshot.
+          "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
           "kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
           "storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
-          "sourceDisk": "A String", # The source disk used to create this snapshot.
-          "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+          "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
           "sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
           "diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB.
-          "licenses": [ # Public visible licenses.
+          "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
             "A String",
           ],
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#snapshotList", # Type of resource.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
   }
diff --git a/docs/dyn/compute_v1.sslCertificates.html b/docs/dyn/compute_v1.sslCertificates.html new file mode 100644 index 00000000000..88208956cbf --- /dev/null +++ b/docs/dyn/compute_v1.sslCertificates.html @@ -0,0 +1,300 @@ + + + +

Compute Engine API . sslCertificates

+

Instance Methods

+

+ delete(project, sslCertificate)

+

Deletes the specified SslCertificate resource.

+

+ get(project, sslCertificate)

+

Returns the specified SslCertificate resource.

+

+ insert(project, body)

+

Creates a SslCertificate resource in the specified project using the data included in the request.

+

+ list(project, maxResults=None, pageToken=None, filter=None)

+

Retrieves the list of SslCertificate resources available to the specified project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ delete(project, sslCertificate) +
Deletes the specified SslCertificate resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  sslCertificate: string, Name of the SslCertificate resource to delete. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ get(project, sslCertificate) +
Returns the specified SslCertificate resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  sslCertificate: string, Name of the SslCertificate resource to return. (required)
+
+Returns:
+  An object of the form:
+
+    { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+      "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+      "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    }
+
+ +
+ insert(project, body) +
Creates a SslCertificate resource in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+    "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+    "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ list(project, maxResults=None, pageToken=None, filter=None) +
Retrieves the list of SslCertificate resources available to the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of SslCertificate resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # A list of SslCertificate resources.
+      { # An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.
+          "kind": "compute#sslCertificate", # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+          "certificate": "A String", # A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.
+          "privateKey": "A String", # A write-only private key in PEM format. Only insert RPCs will include this field.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+        },
+    ],
+    "kind": "compute#sslCertificateList", # Type of resource.
+    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html new file mode 100644 index 00000000000..429ccd6b2c0 --- /dev/null +++ b/docs/dyn/compute_v1.subnetworks.html @@ -0,0 +1,388 @@ + + + +

Compute Engine API . subnetworks

+

Instance Methods

+

+ aggregatedList(project, maxResults=None, pageToken=None, filter=None)

+

Retrieves an aggregated list of subnetworks.

+

+ aggregatedList_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ delete(project, region, subnetwork)

+

Deletes the specified subnetwork.

+

+ get(project, region, subnetwork)

+

Returns the specified subnetwork.

+

+ insert(project, region, body)

+

Creates a subnetwork in the specified project using the data included in the request.

+

+ list(project, region, maxResults=None, pageToken=None, filter=None)

+

Retrieves a list of subnetworks available to the specified project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ aggregatedList(project, maxResults=None, pageToken=None, filter=None) +
Retrieves an aggregated list of subnetworks.
+
+Args:
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    {
+    "nextPageToken": "A String", # [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.
+    "items": { # [Output] A map of scoped Subnetwork lists.
+      "a_key": { # Name of the scope containing this set of Subnetworks.
+        "subnetworks": [ # List of subnetworks contained in this scope.
+          { # A Subnetwork resource.
+              "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+              "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+              "region": "A String", # [Output Only] URL of the region where the Subnetwork resides.
+              "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+              "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+              "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+              "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+              "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+            },
+        ],
+        "warning": { # An informational warning that appears when the list of addresses is empty.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+            {
+              "value": "A String", # [Output Only] A warning data value corresponding to the key.
+              "key": "A String", # [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).
+            },
+          ],
+        },
+      },
+    },
+    "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  }
+
+ +
+ aggregatedList_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ delete(project, region, subnetwork) +
Deletes the specified subnetwork.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  subnetwork: string, Name of the Subnetwork resource to delete. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ get(project, region, subnetwork) +
Returns the specified subnetwork.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  subnetwork: string, Name of the Subnetwork resource to return. (required)
+
+Returns:
+  An object of the form:
+
+    { # A Subnetwork resource.
+      "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "region": "A String", # [Output Only] URL of the region where the Subnetwork resides.
+      "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+      "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+      "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    }
+
+ +
+ insert(project, region, body) +
Creates a subnetwork in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A Subnetwork resource.
+    "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "region": "A String", # [Output Only] URL of the region where the Subnetwork resides.
+    "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+    "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+    "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ list(project, region, maxResults=None, pageToken=None, filter=None) +
Retrieves a list of subnetworks available to the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of Subnetwork resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # The Subnetwork resources.
+      { # A Subnetwork resource.
+          "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "region": "A String", # [Output Only] URL of the region where the Subnetwork resides.
+          "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks.
+          "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network.
+          "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+        },
+    ],
+    "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.targetHttpProxies.html b/docs/dyn/compute_v1.targetHttpProxies.html index 7b0f5113204..e517791b54b 100644 --- a/docs/dyn/compute_v1.targetHttpProxies.html +++ b/docs/dyn/compute_v1.targetHttpProxies.html @@ -98,42 +98,44 @@

Method Details

Deletes the specified TargetHttpProxy resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -143,9 +145,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -154,18 +156,18 @@

Method Details

Returns the specified TargetHttpProxy resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
 
 Returns:
   An object of the form:
 
     { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
-      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#Operation for Operation resources.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+      "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
     }
@@ -176,16 +178,16 @@

Method Details

Creates a TargetHttpProxy resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
-    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#Operation for Operation resources.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -195,35 +197,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -233,9 +237,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -244,33 +248,37 @@

Method Details

Retrieves the list of TargetHttpProxy resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # A list of TargetHttpProxy resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of TargetHttpProxy resources.
       { # A TargetHttpProxy resource. This resource defines an HTTP proxy.
-          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#Operation for Operation resources.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
-    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of Target HTTP proxies.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
   }
@@ -294,8 +302,8 @@

Method Details

Changes the URL map for TargetHttpProxy.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  targetHttpProxy: string, Name of the TargetHttpProxy resource whose URL map is to be set. (required)
+  project: string, Project ID for this request. (required)
+  targetHttpProxy: string, The name of the TargetHttpProxy resource to set a URL map for. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
@@ -308,35 +316,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -346,9 +356,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html new file mode 100644 index 00000000000..69fd4c80da3 --- /dev/null +++ b/docs/dyn/compute_v1.targetHttpsProxies.html @@ -0,0 +1,453 @@ + + + +

Compute Engine API . targetHttpsProxies

+

Instance Methods

+

+ delete(project, targetHttpsProxy)

+

Deletes the specified TargetHttpsProxy resource.

+

+ get(project, targetHttpsProxy)

+

Returns the specified TargetHttpsProxy resource.

+

+ insert(project, body)

+

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

+

+ list(project, maxResults=None, pageToken=None, filter=None)

+

Retrieves the list of TargetHttpsProxy resources available to the specified project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ setSslCertificates(project, targetHttpsProxy, body)

+

Replaces SslCertificates for TargetHttpsProxy.

+

+ setUrlMap(project, targetHttpsProxy, body)

+

Changes the URL map for TargetHttpsProxy.

+

Method Details

+
+ delete(project, targetHttpsProxy) +
Deletes the specified TargetHttpsProxy resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ get(project, targetHttpsProxy) +
Returns the specified TargetHttpsProxy resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
+
+Returns:
+  An object of the form:
+
+    { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+      "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+        "A String",
+      ],
+      "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+          # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+          # - projects/project/global/urlMaps/url-map
+          # - global/urlMaps/url-map
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    }
+
+ +
+ insert(project, body) +
Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+    "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+    "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+      "A String",
+    ],
+    "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+        # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+        # - projects/project/global/urlMaps/url-map
+        # - global/urlMaps/url-map
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ list(project, maxResults=None, pageToken=None, filter=None) +
Retrieves the list of TargetHttpsProxy resources available to the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of TargetHttpsProxy resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # A list of TargetHttpsProxy resources.
+      { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy.
+          "kind": "compute#targetHttpsProxy", # [Output Only] Type of the resource. Always compute#targetHttpsProxy for target HTTPS proxies.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.
+            "A String",
+          ],
+          "urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
+              # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
+              # - projects/project/global/urlMaps/url-map
+              # - global/urlMaps/url-map
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+        },
+    ],
+    "kind": "compute#targetHttpsProxyList", # Type of resource.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ setSslCertificates(project, targetHttpsProxy, body) +
Replaces SslCertificates for TargetHttpsProxy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SSL certificate for. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetHttpProxy. Currently exactly one SSL certificate must be specified.
+      "A String",
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ +
+ setUrlMap(project, targetHttpsProxy, body) +
Changes the URL map for TargetHttpsProxy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "urlMap": "A String",
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.targetInstances.html b/docs/dyn/compute_v1.targetInstances.html index 09434c0b342..9720c489d0e 100644 --- a/docs/dyn/compute_v1.targetInstances.html +++ b/docs/dyn/compute_v1.targetInstances.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of target instances grouped by scope.

+

Retrieves an aggregated list of target instances.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,52 +91,60 @@

Instance Methods

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of TargetInstance resources available to the specified project and zone.

+

Retrieves a list of TargetInstance resources available to the specified project and zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of target instances grouped by scope.
+  
Retrieves an aggregated list of target instances.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # A map of scoped target instance lists.
       "a_key": { # Name of the scope containing this set of target instances.
         "targetInstances": [ # List of target instances contained in this scope.
           { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
-              "kind": "compute#targetInstance", # Type of the resource.
-              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+              "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
               "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
               "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
-              "instance": "A String", # The URL to the instance that terminates the relevant traffic.
+              "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+                  # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+                  # - projects/project/zones/zone/instances/instance
+                  # - zones/zone/instances/instance
               "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-              "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+              "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
               "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
               "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
             },
         ],
         "warning": { # Informational warning which replaces the list of addresses when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
@@ -167,7 +175,7 @@ 

Method Details

Deletes the specified TargetInstance resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   targetInstance: string, Name of the TargetInstance resource to delete. (required)
 
@@ -175,35 +183,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -213,9 +223,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -224,7 +234,7 @@

Method Details

Returns the specified TargetInstance resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   targetInstance: string, Name of the TargetInstance resource to return. (required)
 
@@ -232,13 +242,16 @@ 

Method Details

An object of the form: { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. - "kind": "compute#targetInstance", # Type of the resource. - "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created. + "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "zone": "A String", # [Output Only] URL of the zone where the target instance resides. "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. - "instance": "A String", # The URL to the instance that terminates the relevant traffic. + "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance + # - projects/project/zones/zone/instances/instance + # - zones/zone/instances/instance "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -249,19 +262,22 @@

Method Details

Creates a TargetInstance resource in the specified project and zone using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
-    "kind": "compute#targetInstance", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
     "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
-    "instance": "A String", # The URL to the instance that terminates the relevant traffic.
+    "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+        # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+        # - projects/project/zones/zone/instances/instance
+        # - zones/zone/instances/instance
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
     "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
   }
@@ -271,35 +287,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -309,47 +327,54 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of TargetInstance resources available to the specified project and zone.
+  
Retrieves a list of TargetInstance resources available to the specified project and zone.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   zone: string, Name of the zone scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of TargetInstance resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of TargetInstance resources.
       { # A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.
-          "kind": "compute#targetInstance", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "zone": "A String", # [Output Only] URL of the zone where the target instance resides.
           "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
-          "instance": "A String", # The URL to the instance that terminates the relevant traffic.
+          "instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
+              # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
+              # - projects/project/zones/zone/instances/instance
+              # - zones/zone/instances/instance
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#targetInstanceList", # Type of resource.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
   }
diff --git a/docs/dyn/compute_v1.targetPools.html b/docs/dyn/compute_v1.targetPools.html index a1c2e61fa3e..78391080bf8 100644 --- a/docs/dyn/compute_v1.targetPools.html +++ b/docs/dyn/compute_v1.targetPools.html @@ -76,58 +76,61 @@

Compute Engine API . addHealthCheck(project, region, targetPool, body)

-

Adds health check URL to targetPool.

+

Adds health check URLs to a target pool.

addInstance(project, region, targetPool, body)

-

Adds instance url to targetPool.

+

Adds an instance to a target pool.

aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of target pools grouped by scope.

+

Retrieves an aggregated list of target pools.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetPool)

-

Deletes the specified TargetPool resource.

+

Deletes the specified target pool.

get(project, region, targetPool)

-

Returns the specified TargetPool resource.

+

Returns the specified target pool.

getHealth(project, region, targetPool, body)

-

Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.

+

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

insert(project, region, body)

-

Creates a TargetPool resource in the specified project and region using the data included in the request.

+

Creates a target pool in the specified project and region using the data included in the request.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of TargetPool resources available to the specified project and region.

+

Retrieves a list of target pools available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

removeHealthCheck(project, region, targetPool, body)

-

Removes health check URL from targetPool.

+

Removes health check URL from a target pool.

removeInstance(project, region, targetPool, body)

-

Removes instance URL from targetPool.

+

Removes instance URL from a target pool.

setBackup(project, region, targetPool, body, failoverRatio=None)

-

Changes backup pool configurations.

+

Changes a backup target pool's configurations.

Method Details

addHealthCheck(project, region, targetPool, body) -
Adds health check URL to targetPool.
+  
Adds health check URLs to a target pool.
 
 Args:
-  project: string, A parameter (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  targetPool: string, Name of the TargetPool resource to which health_check_url is to be added. (required)
+  targetPool: string, Name of the target pool to add a health check to. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "healthChecks": [ # Health check URLs to be added to targetPool.
-      {
+    "healthChecks": [ # A list of HttpHealthCheck resources to add to the target pool.
+      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+          # - projects/project-id/global/httpHealthChecks/health-check
+          # - global/httpHealthChecks/health-check
         "healthCheck": "A String",
       },
     ],
@@ -138,35 +141,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -176,27 +181,30 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
addInstance(project, region, targetPool, body) -
Adds instance url to targetPool.
+  
Adds an instance to a target pool.
 
 Args:
-  project: string, A parameter (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  targetPool: string, Name of the TargetPool resource to which instance_url is to be added. (required)
+  targetPool: string, Name of the TargetPool resource to add instances to. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # URLs of the instances to be added to targetPool.
+    "instances": [ # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs:
+        # - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name
+        # - projects/project-id/zones/zone/instances/instance-name
+        # - zones/zone/instances/instance-name
       {
-        "instance": "A String",
+        "instance": "A String", # The URL for a specific instance.
       },
     ],
   }
@@ -206,35 +214,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -244,55 +254,63 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of target pools grouped by scope.
+  
Retrieves an aggregated list of target pools.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
-    "items": { # A map of scoped target pool lists.
+    "nextPageToken": "A String", # [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.
+    "items": { # [Output Only] A map of scoped target pool lists.
       "a_key": { # Name of the scope containing this set of target pools.
         "warning": { # Informational warning which replaces the list of addresses when the list is empty.
-          "message": "A String", # [Output Only] Optional human-readable details for this warning.
-          "code": "A String", # [Output Only] The warning type identifier for this warning.
-          "data": [ # [Output Only] Metadata for this warning in key: value format.
+          "message": "A String", # [Output Only] A human-readable description of the warning code.
+          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
             {
               "value": "A String", # [Output Only] A warning data value corresponding to the key.
-              "key": "A String", # [Output Only] A key for the warning data.
+              "key": "A String", # [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).
             },
           ],
         },
         "targetPools": [ # List of target pools contained in this scope.
-          { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
+          { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
               "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
                   #
                   # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
                   #
                   # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
-              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
               "region": "A String", # [Output Only] URL of the region where the target pool resides.
-              "kind": "compute#targetPool", # Type of the resource.
-              "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
-              "instances": [ # A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.
+              "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+              "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+                  # NONE: Connections from the same client IP may go to any instance in the pool.
+                  # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+                  # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+              "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
                 "A String",
               ],
               "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
@@ -304,14 +322,14 @@ 

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], }, }, - "kind": "compute#targetPoolAggregatedList", # Type of resource. + "kind": "compute#targetPoolAggregatedList", # [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -333,10 +351,10 @@

Method Details

delete(project, region, targetPool) -
Deletes the specified TargetPool resource.
+  
Deletes the specified target pool.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   targetPool: string, Name of the TargetPool resource to delete. (required)
 
@@ -344,35 +362,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -382,35 +402,38 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, region, targetPool) -
Returns the specified TargetPool resource.
+  
Returns the specified target pool.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   targetPool: string, Name of the TargetPool resource to return. (required)
 
 Returns:
   An object of the form:
 
-    { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
+    { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
       "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
           #
           # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
           #
           # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
-      "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "region": "A String", # [Output Only] URL of the region where the target pool resides.
-      "kind": "compute#targetPool", # Type of the resource.
-      "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
-      "instances": [ # A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.
+      "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+      "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+          # NONE: Connections from the same client IP may go to any instance in the pool.
+          # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+          # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+      "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
         "A String",
       ],
       "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
@@ -422,7 +445,7 @@ 

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -430,17 +453,17 @@

Method Details

getHealth(project, region, targetPool, body) -
Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.
+  
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
 
 Args:
-  project: string, A parameter (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   targetPool: string, Name of the TargetPool resource to which the queried instance belongs. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-  "instance": "A String",
+  "instance": "A String", # The URL for a specific instance.
 }
 
 
@@ -448,7 +471,7 @@ 

Method Details

An object of the form: { - "kind": "compute#targetPoolInstanceHealth", # Type of resource. + "kind": "compute#targetPoolInstanceHealth", # [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance. "healthStatus": [ { "instance": "A String", # URL of the instance resource. @@ -462,25 +485,28 @@

Method Details

insert(project, region, body) -
Creates a TargetPool resource in the specified project and region using the data included in the request.
+  
Creates a target pool in the specified project and region using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
+{ # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
     "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
         # 
         # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
         # 
         # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
-    "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "region": "A String", # [Output Only] URL of the region where the target pool resides.
-    "kind": "compute#targetPool", # Type of the resource.
-    "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
-    "instances": [ # A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.
+    "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+    "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+        # NONE: Connections from the same client IP may go to any instance in the pool.
+        # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+        # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+    "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
       "A String",
     ],
     "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
@@ -492,7 +518,7 @@ 

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -502,35 +528,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -540,44 +568,51 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of TargetPool resources available to the specified project and region.
+  
Retrieves a list of target pools available to the specified project and region.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-For example, filter=name ne example-instance.
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of TargetPool resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of TargetPool resources.
-      { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback TargetPool.
+      { # A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
           "failoverRatio": 3.14, # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].
               #
               # If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.
               #
               # In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.
-          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "region": "A String", # [Output Only] URL of the region where the target pool resides.
-          "kind": "compute#targetPool", # Type of the resource.
-          "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool; CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
-          "instances": [ # A list of resource URLs to the member virtual machines serving this pool. They must live in zones contained in the same region as this pool.
+          "kind": "compute#targetPool", # [Output Only] Type of the resource. Always compute#targetPool for target pools.
+          "sessionAffinity": "A String", # Sesssion affinity option, must be one of the following values:
+              # NONE: Connections from the same client IP may go to any instance in the pool.
+              # CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.
+              # CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.
+          "instances": [ # A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.
             "A String",
           ],
           "backupPool": "A String", # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].
@@ -589,12 +624,12 @@ 

Method Details

"A String", ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], - "kind": "compute#targetPoolList", # Type of resource. + "kind": "compute#targetPoolList", # [Output Only] Type of resource. Always compute#targetPoolList for lists of target pools. "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -616,18 +651,24 @@

Method Details

removeHealthCheck(project, region, targetPool, body) -
Removes health check URL from targetPool.
+  
Removes health check URL from a target pool.
 
 Args:
-  project: string, A parameter (required)
-  region: string, Name of the region scoping this request. (required)
-  targetPool: string, Name of the TargetPool resource to which health_check_url is to be removed. (required)
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  targetPool: string, Name of the target pool to remove health checks from. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "healthChecks": [ # Health check URLs to be removed from targetPool.
-      {
+    "healthChecks": [ # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs:
+        # - https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check
+        # - projects/project/global/httpHealthChecks/health-check
+        # - global/httpHealthChecks/health-check
+      { # A full or valid partial URL to a health check. For example, the following are valid URLs:
+          # - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check
+          # - projects/project-id/global/httpHealthChecks/health-check
+          # - global/httpHealthChecks/health-check
         "healthCheck": "A String",
       },
     ],
@@ -638,35 +679,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -676,27 +719,27 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
removeInstance(project, region, targetPool, body) -
Removes instance URL from targetPool.
+  
Removes instance URL from a target pool.
 
 Args:
-  project: string, A parameter (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  targetPool: string, Name of the TargetPool resource to which instance_url is to be removed. (required)
+  targetPool: string, Name of the TargetPool resource to remove instances from. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "instances": [ # URLs of the instances to be removed from targetPool.
+    "instances": [ # URLs of the instances to be removed from target pool.
       {
-        "instance": "A String",
+        "instance": "A String", # The URL for a specific instance.
       },
     ],
   }
@@ -706,35 +749,37 @@ 

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -744,20 +789,20 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
setBackup(project, region, targetPool, body, failoverRatio=None) -
Changes backup pool configurations.
+  
Changes a backup target pool's configurations.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
-  targetPool: string, Name of the TargetPool resource for which the backup is to be set. (required)
+  targetPool: string, Name of the TargetPool resource to set a backup pool for. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
@@ -765,41 +810,43 @@ 

Method Details

"target": "A String", } - failoverRatio: number, New failoverRatio value for the containing target pool. + failoverRatio: number, New failoverRatio value for the target pool. Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -809,9 +856,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html index 0a02c15f59e..e2414b03395 100644 --- a/docs/dyn/compute_v1.targetVpnGateways.html +++ b/docs/dyn/compute_v1.targetVpnGateways.html @@ -76,53 +76,57 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of target VPN gateways grouped by scope.

+

Retrieves an aggregated list of target VPN gateways.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

delete(project, region, targetVpnGateway)

-

Deletes the specified TargetVpnGateway resource.

+

Deletes the specified target VPN gateway.

get(project, region, targetVpnGateway)

-

Returns the specified TargetVpnGateway resource.

+

Returns the specified target VPN gateway.

insert(project, region, body)

-

Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.

+

Creates a target VPN gateway in the specified project and region using the data included in the request.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of TargetVpnGateway resources available to the specified project and region.

+

Retrieves a list of target VPN gateways available to the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of target VPN gateways grouped by scope.
+  
Retrieves an aggregated list of target VPN gateways.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # A map of scoped target vpn gateway lists.
-      "a_key": { # [Output Only] Name of the scope containing this set of target vpn gateways.
+      "a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
         "targetVpnGateways": [ # [Output Only] List of target vpn gateways contained in this scope.
-          {
+          { # Represents a Target VPN gateway resource.
               "status": "A String", # [Output Only] The status of the VPN gateway.
               "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
-              "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
-              "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
+              "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+              "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
                 "A String",
               ],
               "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
@@ -131,25 +135,26 @@ 

Method Details

], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. }
@@ -170,46 +175,48 @@

Method Details

delete(project, region, targetVpnGateway) -
Deletes the specified TargetVpnGateway resource.
+  
Deletes the specified target VPN gateway.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
-  targetVpnGateway: string, Name of the TargetVpnGateway resource to delete. (required)
+  targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -219,29 +226,29 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
get(project, region, targetVpnGateway) -
Returns the specified TargetVpnGateway resource.
+  
Returns the specified target VPN gateway.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
-  targetVpnGateway: string, Name of the TargetVpnGateway resource to return. (required)
+  targetVpnGateway: string, Name of the target VPN gateway to return. (required)
 
 Returns:
   An object of the form:
 
-    {
+    { # Represents a Target VPN gateway resource.
       "status": "A String", # [Output Only] The status of the VPN gateway.
       "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
-      "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
-      "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
         "A String",
       ],
       "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
@@ -250,7 +257,7 @@ 

Method Details

], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -258,7 +265,7 @@

Method Details

insert(project, region, body) -
Creates a TargetVpnGateway resource in the specified project and region using the data included in the request.
+  
Creates a target VPN gateway in the specified project and region using the data included in the request.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -266,11 +273,11 @@ 

Method Details

body: object, The request body. (required) The object takes the form of: -{ +{ # Represents a Target VPN gateway resource. "status": "A String", # [Output Only] The status of the VPN gateway. "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. - "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created. - "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway. "A String", ], "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. @@ -279,7 +286,7 @@

Method Details

], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -289,35 +296,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -327,38 +336,42 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of TargetVpnGateway resources available to the specified project and region.
+  
Retrieves a list of target VPN gateways available to the specified project and region.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of TargetVpnGateway resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of TargetVpnGateway resources.
-      {
+      { # Represents a Target VPN gateway resource.
           "status": "A String", # [Output Only] The status of the VPN gateway.
           "kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
-          "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert and associated to a VPN gateway.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.
             "A String",
           ],
           "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides.
@@ -367,13 +380,13 @@ 

Method Details

], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. }
diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index 3250a44d542..4e6788701ba 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -91,55 +91,57 @@

Instance Methods

Retrieves the next page of results.

patch(project, urlMap, body)

-

Update the entire content of the UrlMap resource. This method supports patch semantics.

+

Updates the entire content of the UrlMap resource. This method supports patch semantics.

update(project, urlMap, body)

-

Update the entire content of the UrlMap resource.

+

Updates the entire content of the UrlMap resource.

validate(project, urlMap, body)

-

Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

+

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Method Details

delete(project, urlMap)
Deletes the specified UrlMap resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   urlMap: string, Name of the UrlMap resource to delete. (required)
 
 Returns:
   An object of the form:
 
     { # An Operation resource, used to manage asynchronous API requests.
-    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-    "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] Reserved for future use.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-    "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
     "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-    "progress": 42, # [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.
-    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
     "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
     "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
       {
-        "message": "A String", # [Output Only] Optional human-readable details for this warning.
-        "code": "A String", # [Output Only] The warning type identifier for this warning.
-        "data": [ # [Output Only] Metadata for this warning in key: value format.
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
           {
             "value": "A String", # [Output Only] A warning data value corresponding to the key.
-            "key": "A String", # [Output Only] A key for the warning data.
+            "key": "A String", # [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).
           },
         ],
       },
     ],
     "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
     "name": "A String", # [Output Only] Name of the resource.
-    "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
     "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
       "errors": [ # [Output Only] The array of errors encountered while processing this operation.
         {
@@ -149,9 +151,9 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -160,15 +162,15 @@

Method Details

Returns the specified UrlMap resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   urlMap: string, Name of the UrlMap resource to return. (required)
 
 Returns:
   An object of the form:
 
     { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
-      "kind": "compute#urlMap", # Type of the resource.
-      "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+      "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
       "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
       "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
         { # Message for the expected URL mappings.
@@ -181,8 +183,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -191,19 +196,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -215,13 +220,13 @@

Method Details

Creates a UrlMap resource in the specified project using the data included in the request.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
-    "kind": "compute#urlMap", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
     "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
       { # Message for the expected URL mappings.
@@ -234,8 +239,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -244,19 +252,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -267,35 +275,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -305,9 +315,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -316,24 +326,28 @@

Method Details

Retrieves the list of UrlMap resources available to the specified project.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  project: string, Project ID for this request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+Compute 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.
 
-For example, filter=name ne example-instance.
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of UrlMap resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # A list of UrlMap resources.
       { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
-          "kind": "compute#urlMap", # Type of the resource.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
           "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
             { # Message for the expected URL mappings.
@@ -346,8 +360,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -356,19 +373,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -396,17 +413,17 @@

Method Details

patch(project, urlMap, body) -
Update the entire content of the UrlMap resource. This method supports patch semantics.
+  
Updates the entire content of the UrlMap resource. This method supports patch semantics.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   urlMap: string, Name of the UrlMap resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
-    "kind": "compute#urlMap", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
     "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
       { # Message for the expected URL mappings.
@@ -419,8 +436,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -429,19 +449,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -452,35 +472,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -490,25 +512,25 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
update(project, urlMap, body) -
Update the entire content of the UrlMap resource.
+  
Updates the entire content of the UrlMap resource.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   urlMap: string, Name of the UrlMap resource to update. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
-    "kind": "compute#urlMap", # Type of the resource.
-    "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+    "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+    "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
     "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
     "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
       { # Message for the expected URL mappings.
@@ -521,8 +543,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -531,19 +556,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. @@ -554,35 +579,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -592,26 +619,26 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
validate(project, urlMap, body) -
Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
+  
Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
 
 Args:
-  project: string, Name of the project scoping this request. (required)
+  project: string, Project ID for this request. (required)
   urlMap: string, Name of the UrlMap resource to be validated as. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 {
     "resource": { # A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path. # Content of the UrlMap to be validated.
-        "kind": "compute#urlMap", # Type of the resource.
-        "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+        "kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.
+        "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
         "defaultService": "A String", # The URL of the BackendService resource if none of the hostRules match.
         "tests": [ # The list of expected URL mappings. Request to update this UrlMap will succeed only all of the test cases pass.
           { # Message for the expected URL mappings.
@@ -624,8 +651,11 @@ 

Method Details

"selfLink": "A String", # [Output Only] Server-defined URL for the resource. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap. "pathMatchers": [ # The list of named PathMatchers to use against the URL. - { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default_service will be used. - "defaultService": "A String", # The URL to the BackendService resource. This will be used if none of the 'pathRules' defined by this PathMatcher is met by the URL's path portion. + { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: + # - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService + # - compute/v1/projects/project/global/backendServices/backendService + # - global/backendServices/backendService "pathRules": [ # The list of path rules. { # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL. "paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here. @@ -634,19 +664,19 @@

Method Details

"service": "A String", # The URL of the BackendService resource if this rule is matched. }, ], - "description": "A String", # An optional textual description of the resource. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "name": "A String", # The name to which this PathMatcher is referred by the HostRule. }, ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Set by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "hostRules": [ # The list of HostRules to use against the URL. { # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService. - "hosts": [ # The list of host patterns to match. They must be valid hostnames except that they may start with *. or *-. The * acts like a glob and will match any string of atoms (separated by .s and -s) to the left. + "hosts": [ # The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or .. "A String", ], - "description": "A String", # An optional textual description. - "pathMatcher": "A String", # The name of the PathMatcher to match the path portion of the URL, if the this hostRule matches the URL's host portion. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion. }, ], "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html index 517ee1deb01..fa129e82fdf 100644 --- a/docs/dyn/compute_v1.vpnTunnels.html +++ b/docs/dyn/compute_v1.vpnTunnels.html @@ -76,7 +76,7 @@

Compute Engine API . aggregatedList(project, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of VPN tunnels grouped by scope.

+

Retrieves an aggregated list of VPN tunnels.

aggregatedList_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,30 +91,34 @@

Instance Methods

Creates a VpnTunnel resource in the specified project and region using the data included in the request.

list(project, region, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of VpnTunnel resources contained in the specified project and region.

+

Retrieves a list of VpnTunnel resources contained in the specified project and region.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

aggregatedList(project, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of VPN tunnels grouped by scope.
+  
Retrieves an aggregated list of VPN tunnels.
 
 Args:
   project: string, Project ID for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": { # [Output Only] A map of scoped vpn tunnel lists.
       "a_key": { # Name of the scope containing this set of vpn tunnels.
         "vpnTunnels": [ # List of vpn tunnels contained in this scope.
@@ -122,33 +126,37 @@ 

Method Details

"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. - "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "peerIp": "A String", # IP address of the peer VPN gateway. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. + "A String", + ], "status": "A String", # [Output Only] The status of the VPN tunnel. "sharedSecretHash": "A String", # Hash of the shared secret. "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. - "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway. + "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], "warning": { # Informational warning which replaces the list of addresses when the list is empty. - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, }, }, "kind": "compute#vpnTunnelAggregatedList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
@@ -180,35 +188,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -218,9 +228,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -240,15 +250,18 @@

Method Details

"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. - "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "peerIp": "A String", # IP address of the peer VPN gateway. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. + "A String", + ], "status": "A String", # [Output Only] The status of the VPN tunnel. "sharedSecretHash": "A String", # Hash of the shared secret. "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. - "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway. + "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }
@@ -268,15 +281,18 @@

Method Details

"detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel. "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2. "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. - "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created. + "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "peerIp": "A String", # IP address of the peer VPN gateway. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. + "A String", + ], "status": "A String", # [Output Only] The status of the VPN tunnel. "sharedSecretHash": "A String", # Hash of the shared secret. "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. - "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway. + "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -286,35 +302,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -324,52 +342,59 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, region, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of VpnTunnel resources contained in the specified project and region.
+  
Retrieves a list of VpnTunnel resources contained in the specified project and region.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, The name of the region for this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of VpnTunnel resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "nextPageToken": "A String", # [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.
     "items": [ # [Output Only] A list of VpnTunnel resources.
       {
           "detailedStatus": "A String", # [Output Only] Detailed status message for the VPN tunnel.
           "ikeVersion": 42, # IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.
           "kind": "compute#vpnTunnel", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
-          "description": "A String", # An optional textual description of the resource. Provided by the client when the resource is created.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
           "peerIp": "A String", # IP address of the peer VPN gateway.
           "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides.
+          "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.
+            "A String",
+          ],
           "status": "A String", # [Output Only] The status of the VPN tunnel.
           "sharedSecretHash": "A String", # Hash of the shared secret.
           "targetVpnGateway": "A String", # URL of the VPN gateway to which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.
-          "sharedSecret": "A String", # Shared secret used to set the secure session between the GCE VPN gateway and the peer VPN gateway.
+          "sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-          "id": "A String", # [Output Only] Unique identifier for the resource. Defined by the server.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         },
     ],
     "kind": "compute#vpnTunnelList", # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
-    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
     "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   }
diff --git a/docs/dyn/compute_v1.zoneOperations.html b/docs/dyn/compute_v1.zoneOperations.html index 8b33ef645c4..96297307164 100644 --- a/docs/dyn/compute_v1.zoneOperations.html +++ b/docs/dyn/compute_v1.zoneOperations.html @@ -82,7 +82,7 @@

Instance Methods

Retrieves the specified zone-specific Operations resource.

list(project, zone, maxResults=None, pageToken=None, filter=None)

-

Retrieves the list of Operation resources contained within the specified zone.

+

Retrieves a list of Operation resources contained within the specified zone.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -93,7 +93,7 @@

Method Details

Args: project: string, Project ID for this request. (required) - zone: string, Name of the zone scoping this request. (required) + zone: string, Name of the zone for this request. (required) operation: string, Name of the Operations resource to delete. (required)
@@ -104,42 +104,44 @@

Method Details

Args: project: string, Project ID for this request. (required) - zone: string, Name of the zone scoping this request. (required) + zone: string, Name of the zone for this request. (required) operation: string, Name of the Operations resource to return. (required) Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -149,63 +151,69 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
list(project, zone, maxResults=None, pageToken=None, filter=None) -
Retrieves the list of Operation resources contained within the specified zone.
+  
Retrieves a list of Operation resources contained within the specified zone.
 
 Args:
   project: string, Project ID for this request. (required)
-  zone: string, Name of the zone scoping this request. (required)
-  maxResults: integer, Maximum count of results to be returned.
-  pageToken: string, 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.
-  filter: string, 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.
+  zone: string, Name of the zone for request. (required)
+  maxResults: integer, 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.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
 
-The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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.
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
 
-For example, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
 
 Returns:
   An object of the form:
 
     { # Contains a list of Operation resources.
-    "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
-    "items": [ # [Output Only] The Operation resources.
+    "nextPageToken": "A String", # [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.
+    "items": [ # [Output Only] A list of Operation resources.
       { # An Operation resource, used to manage asynchronous API requests.
-        "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
-        "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+        "clientOperationId": "A String", # [Output Only] Reserved for future use.
         "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-        "zone": "A String", # [Output Only] URL of the zone where the operation resides.
-        "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+        "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
+        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+        "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
         "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
-        "progress": 42, # [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.
-        "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
+        "progress": 42, # [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.
+        "httpErrorStatusCode": 42, # [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.
         "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
-        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
         "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
           {
-            "message": "A String", # [Output Only] Optional human-readable details for this warning.
-            "code": "A String", # [Output Only] The warning type identifier for this warning.
-            "data": [ # [Output Only] Metadata for this warning in key: value format.
+            "message": "A String", # [Output Only] A human-readable description of the warning code.
+            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
               {
                 "value": "A String", # [Output Only] A warning data value corresponding to the key.
-                "key": "A String", # [Output Only] A key for the warning data.
+                "key": "A String", # [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).
               },
             ],
           },
         ],
         "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
-        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
-        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+        "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
         "name": "A String", # [Output Only] Name of the resource.
-        "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
+        "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
         "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
           "errors": [ # [Output Only] The array of errors encountered while processing this operation.
             {
@@ -215,13 +223,13 @@ 

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, ], "kind": "compute#operationList", # [Output Only] Type of resource. Always compute#operations for Operations resource. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for this resource. }
diff --git a/docs/dyn/compute_v1.zones.html b/docs/dyn/compute_v1.zones.html index 9a057505fcd..3c1ed9aaebf 100644 --- a/docs/dyn/compute_v1.zones.html +++ b/docs/dyn/compute_v1.zones.html @@ -97,7 +97,7 @@

Method Details

{ # A Zone resource. "status": "A String", # [Output Only] Status of the zone, either UP or DOWN. - "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones. + "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones. "description": "A String", # [Output Only] Textual description of the resource. "maintenanceWindows": [ # [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 { @@ -116,7 +116,7 @@

Method Details

}, "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }
@@ -128,23 +128,27 @@

Method Details

Args: project: string, Project ID for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. + +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. + +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +Compute 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. -For example, filter=name ne example-instance. +The 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. Returns: An object of the form: { # Contains a list of zone resources. - "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. + "nextPageToken": "A String", # [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. "items": [ # [Output Only] A list of Zone resources. { # A Zone resource. "status": "A String", # [Output Only] Status of the zone, either UP or DOWN. - "kind": "compute#zone", # [Output Only] Type of the resource. Always kind#zone for zones. + "kind": "compute#zone", # [Output Only] Type of the resource. Always compute#zone for zones. "description": "A String", # [Output Only] Textual description of the resource. "maintenanceWindows": [ # [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 { @@ -163,7 +167,7 @@

Method Details

}, "region": "A String", # [Output Only] Full URL reference to the region which hosts the zone. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "name": "A String", # [Output Only] Name of the resource. }, diff --git a/docs/dyn/content_v2.datafeeds.html b/docs/dyn/content_v2.datafeeds.html index fe080373d56..a1deeef6bab 100644 --- a/docs/dyn/content_v2.datafeeds.html +++ b/docs/dyn/content_v2.datafeeds.html @@ -116,7 +116,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -124,7 +124,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -170,7 +170,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -178,7 +178,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -224,7 +224,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -232,7 +232,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -262,7 +262,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -270,7 +270,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -295,7 +295,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -303,7 +303,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -340,7 +340,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -348,7 +348,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -395,7 +395,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -403,7 +403,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -428,7 +428,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -436,7 +436,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -467,7 +467,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -475,7 +475,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". @@ -500,7 +500,7 @@

Method Details

"kind": "content#datafeed", # Identifies what kind of resource this is. Value: the fixed string "content#datafeed". "contentType": "A String", # The type of data feed. "name": "A String", # A descriptive name of the data feed. - "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. + "contentLanguage": "A String", # The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. "format": { # Format of the feed file. "fileEncoding": "A String", # Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. "quotingMode": "A String", # Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. @@ -508,7 +508,7 @@

Method Details

}, "fetchSchedule": { # The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required. # Fetch schedule for the feed file. "username": "A String", # An optional user name for fetch_url. - "hour": 42, # The hour of the day the feed file should be fetched (0-24). + "hour": 42, # The hour of the day the feed file should be fetched (0-23). "fetchUrl": "A String", # The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols. "weekday": "A String", # The day of the week the feed file should be fetched. "timeZone": "A String", # Time zone used for schedule. UTC by default. E.g., "America/Los_Angeles". diff --git a/docs/dyn/content_v2.html b/docs/dyn/content_v2.html index 18488f3b087..4c07ba0ef47 100644 --- a/docs/dyn/content_v2.html +++ b/docs/dyn/content_v2.html @@ -109,6 +109,11 @@

Instance Methods

Returns the inventory Resource.

+

+ orders() +

+

Returns the orders Resource.

+

products()

diff --git a/docs/dyn/content_v2.inventory.html b/docs/dyn/content_v2.inventory.html index c7729a4b8ee..fe84a24b478 100644 --- a/docs/dyn/content_v2.inventory.html +++ b/docs/dyn/content_v2.inventory.html @@ -97,6 +97,13 @@

Method Details

"productId": "A String", # The ID of the product for which to update price and availability. "inventory": { # Price and availability of the product. "kind": "content#inventory", # Identifies what kind of resource this is. Value: the fixed string "content#inventory". + "installment": { # Number and amount of installments to pay for an item. Brazil only. + "amount": { # The amount the buyer has to pay per month. + "currency": "A String", # The currency of the price. + "value": "A String", # The price represented as a number. + }, + "months": "A String", # The number of installments the buyer has to pay. + }, "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. "price": { # The price of the product. "currency": "A String", # The currency of the price. @@ -108,6 +115,11 @@

Method Details

"value": "A String", # The price represented as a number. }, "availability": "A String", # The availability of the product. + "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only. + "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. + "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. + "pointsValue": "A String", # The retailer's loyalty points in absolute value. + }, "quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products. }, "merchantId": "A String", # The ID of the managing account. @@ -154,6 +166,13 @@

Method Details

The object takes the form of: { + "installment": { # Number and amount of installments to pay for an item. Brazil only. + "amount": { # The amount the buyer has to pay per month. + "currency": "A String", # The currency of the price. + "value": "A String", # The price represented as a number. + }, + "months": "A String", # The number of installments the buyer has to pay. + }, "salePriceEffectiveDate": "A String", # A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided. "price": { # The price of the product. "currency": "A String", # The currency of the price. @@ -165,6 +184,11 @@

Method Details

"value": "A String", # The price represented as a number. }, "availability": "A String", # The availability of the product. + "loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only. + "ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0. + "name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. + "pointsValue": "A String", # The retailer's loyalty points in absolute value. + }, "quantity": 42, # The quantity of the product. Must be equal to or greater than zero. Supported only for local products. } diff --git a/docs/dyn/content_v2.orders.html b/docs/dyn/content_v2.orders.html new file mode 100644 index 00000000000..c41153be133 --- /dev/null +++ b/docs/dyn/content_v2.orders.html @@ -0,0 +1,1618 @@ + + + +

Content API for Shopping . orders

+

Instance Methods

+

+ acknowledge(merchantId, orderId, body)

+

Marks an order as acknowledged.

+

+ advancetestorder(merchantId, orderId)

+

Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".

+

+ cancel(merchantId, orderId, body)

+

Cancels all line items in an order.

+

+ cancellineitem(merchantId, orderId, body)

+

Cancels a line item.

+

+ createtestorder(merchantId, body)

+

Sandbox only. Creates a test order.

+

+ custombatch(body)

+

Retrieves or modifies multiple orders in a single request.

+

+ get(merchantId, orderId)

+

Retrieves an order from your Merchant Center account.

+

+ getbymerchantorderid(merchantId, merchantOrderId)

+

Retrieves an order using merchant order id.

+

+ gettestordertemplate(merchantId, templateName)

+

Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.

+

+ list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None)

+

Lists the orders in your Merchant Center account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ refund(merchantId, orderId, body)

+

Refund a portion of the order, up to the full amount paid.

+

+ returnlineitem(merchantId, orderId, body)

+

Returns a line item.

+

+ shiplineitems(merchantId, orderId, body)

+

Marks line item(s) as shipped.

+

+ updatemerchantorderid(merchantId, orderId, body)

+

Updates the merchant order ID for a given order.

+

+ updateshipment(merchantId, orderId, body)

+

Updates a shipment's status, carrier, and/or tracking ID.

+

Method Details

+
+ acknowledge(merchantId, orderId, body) +
Marks an order as acknowledged.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersAcknowledgeResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAcknowledgeResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ advancetestorder(merchantId, orderId) +
Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment".
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the test order to modify. (required)
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersAdvanceTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersAdvanceTestOrderResponse".
+  }
+
+ +
+ cancel(merchantId, orderId, body) +
Cancels all line items in an order.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order to cancel. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "reason": "A String", # The reason for the cancellation.
+    "reasonText": "A String", # The explanation of the reason.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersCancelResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ cancellineitem(merchantId, orderId, body) +
Cancels a line item.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "reason": "A String", # The reason for the cancellation.
+    "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
+      "currency": "A String", # The currency of the price.
+      "value": "A String", # The price represented as a number.
+    },
+    "reasonText": "A String", # The explanation of the reason.
+    "lineItemId": "A String", # The ID of the line item to cancel.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+    "quantity": 42, # The quantity to cancel.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersCancelLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCancelLineItemResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ createtestorder(merchantId, body) +
Sandbox only. Creates a test order.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "testOrder": { # The test order to create.
+      "customer": { # The details of the customer who placed the order.
+        "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
+        "fullName": "A String", # Full name of the customer.
+        "email": "A String", # Email address of the customer.
+      },
+      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+        {
+          "benefits": [
+            {
+              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+                "A String",
+              ],
+              "discount": { # The discount in the order price when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+              "taxImpact": { # The impact on tax when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+            },
+          ],
+          "longTitle": "A String", # The full title of the promotion.
+          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+          "id": "A String", # The unique ID of the promotion.
+        },
+      ],
+      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
+      "shippingCostTax": { # The tax for the total shipping cost.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
+      "shippingCost": { # The total cost of shipping for all items.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "shippingOption": "A String", # The requested shipping option.
+      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
+        {
+          "returnInfo": { # Details of the return policy for the line item.
+            "policyUrl": "A String", # URL of the item return policy.
+            "isReturnable": True or False, # Whether the item is returnable.
+            "daysToReturn": 42, # How many days later the item can be returned.
+          },
+          "product": { # Product data from the time of the order placement.
+            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+            "title": "A String", # The title of the product.
+            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+            "variantAttributes": [ # Variant attributes for the item. Optional.
+              {
+                "dimension": "A String", # The dimension of the variant.
+                "value": "A String", # The value for the dimension.
+              },
+            ],
+            "brand": "A String", # Brand of the item.
+            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+            "offerId": "A String", # An identifier of the item.
+            "imageLink": "A String", # URL of an image of the item.
+            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+            "channel": "A String", # The item's channel.
+            "price": { # The price for the product.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "condition": "A String", # Condition or state of the item.
+          },
+          "unitTax": { # Unit tax for the line item.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "quantityOrdered": 42, # Number of items ordered.
+          "shippingDetails": { # Details of the requested shipping for the line item.
+            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+            "method": { # Details of the shipping method.
+              "minDaysInTransit": 42, # Minimum transit time.
+              "carrier": "A String", # The carrier for the shipping. Optional.
+              "methodName": "A String", # The name of the shipping method.
+              "maxDaysInTransit": 42, # Maximum transit time.
+            },
+            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+          },
+        },
+      ],
+      "paymentMethod": { # The details of the payment method.
+        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
+        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+        "lastFourDigits": "A String", # The last four digits of the card number.
+        "predefinedBillingAddress": "A String", # The billing address.
+      },
+    },
+    "templateName": "A String", # The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "orderId": "A String", # The ID of the newly created test order.
+    "kind": "content#ordersCreateTestOrderResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCreateTestOrderResponse".
+  }
+
+ +
+ custombatch(body) +
Retrieves or modifies multiple orders in a single request.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "entries": [ # The request entries to be processed in the batch.
+      {
+        "orderId": "A String", # The ID of the order. Required for all methods beside getByMerchantOrderId.
+        "merchantOrderId": "A String", # The merchant order id. Required for updateMerchantOrderId and getByMerchantOrderId methods.
+        "shipLineItems": { # Required for shipLineItems method.
+          "lineItems": [ # Line items to ship.
+            {
+              "lineItemId": "A String", # The id of the line item that is shipped.
+              "quantity": 42, # The quantity that is shipped.
+            },
+          ],
+          "carrier": "A String", # The carrier handling the shipment.
+          "trackingId": "A String", # The tracking id for the shipment.
+          "shipmentId": "A String", # The ID of the shipment.
+        },
+        "updateShipment": { # Required for updateShipment method.
+          "status": "A String", # New status for the shipment. Not updated if missing.
+          "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
+          "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
+          "shipmentId": "A String", # The ID of the shipment.
+        },
+        "method": "A String", # The method to apply.
+        "batchId": 42, # An entry ID, unique within the batch request.
+        "cancelLineItem": { # Required for cancelLineItem method.
+          "amount": { # Amount to refund for the cancelation. Optional. If not set, Google will calculate the default based on the price and tax of the items involved. The amount must not be larger than the net amount left on the order.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "reasonText": "A String", # The explanation of the reason.
+          "reason": "A String", # The reason for the cancellation.
+          "lineItemId": "A String", # The ID of the line item to cancel.
+          "quantity": 42, # The quantity to cancel.
+        },
+        "refund": { # Required for refund method.
+          "amount": { # The amount that is refunded.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "reasonText": "A String", # The explanation of the reason.
+          "reason": "A String", # The reason for the refund.
+        },
+        "cancel": { # Required for cancel method.
+          "reason": "A String", # The reason for the cancellation.
+          "reasonText": "A String", # The explanation of the reason.
+        },
+        "returnLineItem": { # Required for returnLineItem method.
+          "reason": "A String", # The reason for the return.
+          "reasonText": "A String", # The explanation of the reason.
+          "lineItemId": "A String", # The ID of the line item to return.
+          "quantity": 42, # The quantity to return.
+        },
+        "merchantId": "A String", # The ID of the managing account.
+        "operationId": "A String", # The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponse".
+    "entries": [ # The result of the execution of the batch requests.
+      {
+        "batchId": 42, # The ID of the request entry this entry responds to.
+        "kind": "content#ordersCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry".
+        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
+          "message": "A String", # The message of the first error in errors.
+          "code": 42, # The HTTP status of the first error in errors.
+          "errors": [ # A list of errors.
+            { # An error returned by the API.
+              "reason": "A String", # The error code.
+              "domain": "A String", # The domain of the error.
+              "message": "A String", # A description of the error.
+            },
+          ],
+        },
+        "order": { # The retrieved order. Only defined if the method is get and if the request was successful.
+          "customer": { # The details of the customer who placed the order.
+            "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+            "fullName": "A String", # Full name of the customer.
+            "email": "A String", # Email address of the customer.
+          },
+          "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+            {
+              "benefits": [
+                {
+                  "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+                    "A String",
+                  ],
+                  "discount": { # The discount in the order price when the promotion is applied.
+                    "currency": "A String", # The currency of the price.
+                    "value": "A String", # The price represented as a number.
+                  },
+                  "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+                  "taxImpact": { # The impact on tax when the promotion is applied.
+                    "currency": "A String", # The currency of the price.
+                    "value": "A String", # The price represented as a number.
+                  },
+                  "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+                },
+              ],
+              "longTitle": "A String", # The full title of the promotion.
+              "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+              "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+              "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+              "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+                  # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+              "id": "A String", # The unique ID of the promotion.
+            },
+          ],
+          "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+          "shippingCostTax": { # The tax for the total shipping cost.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "shipments": [ # Shipments of the order.
+            {
+              "status": "A String", # The status of the shipment.
+              "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+              "carrier": "A String", # The carrier handling the shipment.
+              "trackingId": "A String", # The tracking id for the shipment.
+              "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+              "lineItems": [ # The line items that are shipped.
+                {
+                  "lineItemId": "A String", # The id of the line item that is shipped.
+                  "quantity": 42, # The quantity that is shipped.
+                },
+              ],
+              "id": "A String", # The id of the shipment.
+            },
+          ],
+          "refunds": [ # Refunds for the order.
+            {
+              "amount": { # The amount that is refunded.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+              "reason": "A String", # The reason for the refund.
+              "actor": "A String", # The actor that created the refund.
+              "reasonText": "A String", # The explanation of the reason.
+            },
+          ],
+          "paymentMethod": { # The details of the payment method.
+            "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+            "lastFourDigits": "A String", # The last four digits of the card number.
+            "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+            "phoneNumber": "A String", # The billing phone number.
+            "billingAddress": { # The billing address.
+              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+              "country": "A String", # CLDR country code (e.g. "US").
+              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+                  # John Smith
+                  # 1600 Amphitheatre Parkway
+                  # Mountain View, CA, 94043
+                  # United States
+                "A String",
+              ],
+              "streetAddress": [ # Street-level part of the address.
+                "A String",
+              ],
+              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+              "recipientName": "A String", # Name of the recipient.
+              "isPostOfficeBox": True or False, # Whether the address is a post office box.
+              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+            },
+            "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+          },
+          "acknowledged": True or False, # Whether the order was acknowledged.
+          "paymentStatus": "A String", # The status of the payment.
+          "merchantId": "A String",
+          "merchantOrderId": "A String", # Merchant-provided id of the order.
+          "shippingOption": "A String", # The requested shipping option.
+          "status": "A String", # The status of the order.
+          "deliveryDetails": { # The details for the delivery.
+            "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+            "address": { # The delivery address
+              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+              "country": "A String", # CLDR country code (e.g. "US").
+              "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+                  # John Smith
+                  # 1600 Amphitheatre Parkway
+                  # Mountain View, CA, 94043
+                  # United States
+                "A String",
+              ],
+              "streetAddress": [ # Street-level part of the address.
+                "A String",
+              ],
+              "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+              "recipientName": "A String", # Name of the recipient.
+              "isPostOfficeBox": True or False, # Whether the address is a post office box.
+              "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+            },
+          },
+          "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+          "shippingCost": { # The total cost of shipping for all items.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "lineItems": [ # Line items that are ordered.
+            {
+              "product": { # Product data from the time of the order placement.
+                "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+                "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+                "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+                "title": "A String", # The title of the product.
+                "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+                "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+                  {
+                    "dimension": "A String", # The dimension of the variant.
+                    "value": "A String", # The value for the dimension.
+                  },
+                ],
+                "brand": "A String", # Brand of the item.
+                "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+                "offerId": "A String", # An identifier of the item.
+                "price": { # Price of the item.
+                  "currency": "A String", # The currency of the price.
+                  "value": "A String", # The price represented as a number.
+                },
+                "imageLink": "A String", # URL of an image of the item.
+                "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+                "channel": "A String", # The item's channel (online or local).
+                "id": "A String", # The REST id of the product.
+                "condition": "A String", # Condition or state of the item.
+              },
+              "quantityDelivered": 42, # Number of items delivered.
+              "returnInfo": { # Details of the return policy for the line item.
+                "policyUrl": "A String", # URL of the item return policy.
+                "isReturnable": True or False, # Whether the item is returnable.
+                "daysToReturn": 42, # How many days later the item can be returned.
+              },
+              "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "quantityPending": 42, # Number of items pending.
+              "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "cancellations": [ # Cancellations of the line item.
+                {
+                  "reason": "A String", # The reason for the cancellation.
+                  "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+                  "reasonText": "A String", # The explanation of the reason.
+                  "actor": "A String", # The actor that created the cancellation.
+                  "quantity": 42, # The quantity that was canceled.
+                },
+              ],
+              "quantityCanceled": 42, # Number of items canceled.
+              "quantityOrdered": 42, # Number of items ordered.
+              "returns": [ # Returns of the line item.
+                {
+                  "reason": "A String", # The reason for the return.
+                  "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+                  "reasonText": "A String", # The explanation of the reason.
+                  "actor": "A String", # The actor that created the refund.
+                  "quantity": 42, # Quantity that is returned.
+                },
+              ],
+              "quantityShipped": 42, # Number of items shipped.
+              "quantityReturned": 42, # Number of items returned.
+              "id": "A String", # The id of the line item.
+              "shippingDetails": { # Details of the requested shipping for the line item.
+                "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+                "method": { # Details of the shipping method.
+                  "minDaysInTransit": 42, # Minimum transit time.
+                  "carrier": "A String", # The carrier for the shipping. Optional.
+                  "methodName": "A String", # The name of the shipping method.
+                  "maxDaysInTransit": 42, # Maximum transit time.
+                },
+                "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+              },
+            },
+          ],
+          "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "id": "A String", # The REST id of the order. Globally unique.
+        },
+        "executionStatus": "A String", # The status of the execution. Only defined if the method is not get or getByMerchantOrderId and if the request was successful.
+      },
+    ],
+  }
+
+ +
+ get(merchantId, orderId) +
Retrieves an order from your Merchant Center account.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+
+Returns:
+  An object of the form:
+
+    {
+    "customer": { # The details of the customer who placed the order.
+      "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+      "fullName": "A String", # Full name of the customer.
+      "email": "A String", # Email address of the customer.
+    },
+    "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+      {
+        "benefits": [
+          {
+            "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+              "A String",
+            ],
+            "discount": { # The discount in the order price when the promotion is applied.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+            "taxImpact": { # The impact on tax when the promotion is applied.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+          },
+        ],
+        "longTitle": "A String", # The full title of the promotion.
+        "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+        "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+        "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+        "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+            # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+        "id": "A String", # The unique ID of the promotion.
+      },
+    ],
+    "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+    "shippingCostTax": { # The tax for the total shipping cost.
+      "currency": "A String", # The currency of the price.
+      "value": "A String", # The price represented as a number.
+    },
+    "shipments": [ # Shipments of the order.
+      {
+        "status": "A String", # The status of the shipment.
+        "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+        "carrier": "A String", # The carrier handling the shipment.
+        "trackingId": "A String", # The tracking id for the shipment.
+        "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+        "lineItems": [ # The line items that are shipped.
+          {
+            "lineItemId": "A String", # The id of the line item that is shipped.
+            "quantity": 42, # The quantity that is shipped.
+          },
+        ],
+        "id": "A String", # The id of the shipment.
+      },
+    ],
+    "refunds": [ # Refunds for the order.
+      {
+        "amount": { # The amount that is refunded.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+        "reason": "A String", # The reason for the refund.
+        "actor": "A String", # The actor that created the refund.
+        "reasonText": "A String", # The explanation of the reason.
+      },
+    ],
+    "paymentMethod": { # The details of the payment method.
+      "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+      "lastFourDigits": "A String", # The last four digits of the card number.
+      "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+      "phoneNumber": "A String", # The billing phone number.
+      "billingAddress": { # The billing address.
+        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+        "country": "A String", # CLDR country code (e.g. "US").
+        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+            # John Smith
+            # 1600 Amphitheatre Parkway
+            # Mountain View, CA, 94043
+            # United States
+          "A String",
+        ],
+        "streetAddress": [ # Street-level part of the address.
+          "A String",
+        ],
+        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+        "recipientName": "A String", # Name of the recipient.
+        "isPostOfficeBox": True or False, # Whether the address is a post office box.
+        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+      },
+      "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+    },
+    "acknowledged": True or False, # Whether the order was acknowledged.
+    "paymentStatus": "A String", # The status of the payment.
+    "merchantId": "A String",
+    "merchantOrderId": "A String", # Merchant-provided id of the order.
+    "shippingOption": "A String", # The requested shipping option.
+    "status": "A String", # The status of the order.
+    "deliveryDetails": { # The details for the delivery.
+      "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+      "address": { # The delivery address
+        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+        "country": "A String", # CLDR country code (e.g. "US").
+        "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+            # John Smith
+            # 1600 Amphitheatre Parkway
+            # Mountain View, CA, 94043
+            # United States
+          "A String",
+        ],
+        "streetAddress": [ # Street-level part of the address.
+          "A String",
+        ],
+        "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+        "recipientName": "A String", # Name of the recipient.
+        "isPostOfficeBox": True or False, # Whether the address is a post office box.
+        "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+      },
+    },
+    "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+    "shippingCost": { # The total cost of shipping for all items.
+      "currency": "A String", # The currency of the price.
+      "value": "A String", # The price represented as a number.
+    },
+    "lineItems": [ # Line items that are ordered.
+      {
+        "product": { # Product data from the time of the order placement.
+          "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+          "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+          "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+          "title": "A String", # The title of the product.
+          "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+          "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+            {
+              "dimension": "A String", # The dimension of the variant.
+              "value": "A String", # The value for the dimension.
+            },
+          ],
+          "brand": "A String", # Brand of the item.
+          "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+          "offerId": "A String", # An identifier of the item.
+          "price": { # Price of the item.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "imageLink": "A String", # URL of an image of the item.
+          "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+          "channel": "A String", # The item's channel (online or local).
+          "id": "A String", # The REST id of the product.
+          "condition": "A String", # Condition or state of the item.
+        },
+        "quantityDelivered": 42, # Number of items delivered.
+        "returnInfo": { # Details of the return policy for the line item.
+          "policyUrl": "A String", # URL of the item return policy.
+          "isReturnable": True or False, # Whether the item is returnable.
+          "daysToReturn": 42, # How many days later the item can be returned.
+        },
+        "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "quantityPending": 42, # Number of items pending.
+        "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "cancellations": [ # Cancellations of the line item.
+          {
+            "reason": "A String", # The reason for the cancellation.
+            "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+            "reasonText": "A String", # The explanation of the reason.
+            "actor": "A String", # The actor that created the cancellation.
+            "quantity": 42, # The quantity that was canceled.
+          },
+        ],
+        "quantityCanceled": 42, # Number of items canceled.
+        "quantityOrdered": 42, # Number of items ordered.
+        "returns": [ # Returns of the line item.
+          {
+            "reason": "A String", # The reason for the return.
+            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+            "reasonText": "A String", # The explanation of the reason.
+            "actor": "A String", # The actor that created the refund.
+            "quantity": 42, # Quantity that is returned.
+          },
+        ],
+        "quantityShipped": 42, # Number of items shipped.
+        "quantityReturned": 42, # Number of items returned.
+        "id": "A String", # The id of the line item.
+        "shippingDetails": { # Details of the requested shipping for the line item.
+          "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+          "method": { # Details of the shipping method.
+            "minDaysInTransit": 42, # Minimum transit time.
+            "carrier": "A String", # The carrier for the shipping. Optional.
+            "methodName": "A String", # The name of the shipping method.
+            "maxDaysInTransit": 42, # Maximum transit time.
+          },
+          "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+        },
+      },
+    ],
+    "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+      "currency": "A String", # The currency of the price.
+      "value": "A String", # The price represented as a number.
+    },
+    "id": "A String", # The REST id of the order. Globally unique.
+  }
+
+ +
+ getbymerchantorderid(merchantId, merchantOrderId) +
Retrieves an order using merchant order id.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  merchantOrderId: string, The merchant order id to be looked for. (required)
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersGetByMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetByMerchantOrderIdResponse".
+    "order": { # The requested order.
+      "customer": { # The details of the customer who placed the order.
+        "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+        "fullName": "A String", # Full name of the customer.
+        "email": "A String", # Email address of the customer.
+      },
+      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+        {
+          "benefits": [
+            {
+              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+                "A String",
+              ],
+              "discount": { # The discount in the order price when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+              "taxImpact": { # The impact on tax when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+            },
+          ],
+          "longTitle": "A String", # The full title of the promotion.
+          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+          "id": "A String", # The unique ID of the promotion.
+        },
+      ],
+      "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+      "shippingCostTax": { # The tax for the total shipping cost.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "shipments": [ # Shipments of the order.
+        {
+          "status": "A String", # The status of the shipment.
+          "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+          "carrier": "A String", # The carrier handling the shipment.
+          "trackingId": "A String", # The tracking id for the shipment.
+          "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+          "lineItems": [ # The line items that are shipped.
+            {
+              "lineItemId": "A String", # The id of the line item that is shipped.
+              "quantity": 42, # The quantity that is shipped.
+            },
+          ],
+          "id": "A String", # The id of the shipment.
+        },
+      ],
+      "refunds": [ # Refunds for the order.
+        {
+          "amount": { # The amount that is refunded.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+          "reason": "A String", # The reason for the refund.
+          "actor": "A String", # The actor that created the refund.
+          "reasonText": "A String", # The explanation of the reason.
+        },
+      ],
+      "paymentMethod": { # The details of the payment method.
+        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+        "lastFourDigits": "A String", # The last four digits of the card number.
+        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+        "phoneNumber": "A String", # The billing phone number.
+        "billingAddress": { # The billing address.
+          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+          "country": "A String", # CLDR country code (e.g. "US").
+          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+              # John Smith
+              # 1600 Amphitheatre Parkway
+              # Mountain View, CA, 94043
+              # United States
+            "A String",
+          ],
+          "streetAddress": [ # Street-level part of the address.
+            "A String",
+          ],
+          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+          "recipientName": "A String", # Name of the recipient.
+          "isPostOfficeBox": True or False, # Whether the address is a post office box.
+          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+        },
+        "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+      },
+      "acknowledged": True or False, # Whether the order was acknowledged.
+      "paymentStatus": "A String", # The status of the payment.
+      "merchantId": "A String",
+      "merchantOrderId": "A String", # Merchant-provided id of the order.
+      "shippingOption": "A String", # The requested shipping option.
+      "status": "A String", # The status of the order.
+      "deliveryDetails": { # The details for the delivery.
+        "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+        "address": { # The delivery address
+          "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+          "country": "A String", # CLDR country code (e.g. "US").
+          "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+              # John Smith
+              # 1600 Amphitheatre Parkway
+              # Mountain View, CA, 94043
+              # United States
+            "A String",
+          ],
+          "streetAddress": [ # Street-level part of the address.
+            "A String",
+          ],
+          "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+          "recipientName": "A String", # Name of the recipient.
+          "isPostOfficeBox": True or False, # Whether the address is a post office box.
+          "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+        },
+      },
+      "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+      "shippingCost": { # The total cost of shipping for all items.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "lineItems": [ # Line items that are ordered.
+        {
+          "product": { # Product data from the time of the order placement.
+            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+            "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+            "title": "A String", # The title of the product.
+            "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+            "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+              {
+                "dimension": "A String", # The dimension of the variant.
+                "value": "A String", # The value for the dimension.
+              },
+            ],
+            "brand": "A String", # Brand of the item.
+            "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+            "offerId": "A String", # An identifier of the item.
+            "price": { # Price of the item.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "imageLink": "A String", # URL of an image of the item.
+            "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+            "channel": "A String", # The item's channel (online or local).
+            "id": "A String", # The REST id of the product.
+            "condition": "A String", # Condition or state of the item.
+          },
+          "quantityDelivered": 42, # Number of items delivered.
+          "returnInfo": { # Details of the return policy for the line item.
+            "policyUrl": "A String", # URL of the item return policy.
+            "isReturnable": True or False, # Whether the item is returnable.
+            "daysToReturn": 42, # How many days later the item can be returned.
+          },
+          "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "quantityPending": 42, # Number of items pending.
+          "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "cancellations": [ # Cancellations of the line item.
+            {
+              "reason": "A String", # The reason for the cancellation.
+              "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+              "reasonText": "A String", # The explanation of the reason.
+              "actor": "A String", # The actor that created the cancellation.
+              "quantity": 42, # The quantity that was canceled.
+            },
+          ],
+          "quantityCanceled": 42, # Number of items canceled.
+          "quantityOrdered": 42, # Number of items ordered.
+          "returns": [ # Returns of the line item.
+            {
+              "reason": "A String", # The reason for the return.
+              "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+              "reasonText": "A String", # The explanation of the reason.
+              "actor": "A String", # The actor that created the refund.
+              "quantity": 42, # Quantity that is returned.
+            },
+          ],
+          "quantityShipped": 42, # Number of items shipped.
+          "quantityReturned": 42, # Number of items returned.
+          "id": "A String", # The id of the line item.
+          "shippingDetails": { # Details of the requested shipping for the line item.
+            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+            "method": { # Details of the shipping method.
+              "minDaysInTransit": 42, # Minimum transit time.
+              "carrier": "A String", # The carrier for the shipping. Optional.
+              "methodName": "A String", # The name of the shipping method.
+              "maxDaysInTransit": 42, # Maximum transit time.
+            },
+            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+          },
+        },
+      ],
+      "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "id": "A String", # The REST id of the order. Globally unique.
+    },
+  }
+
+ +
+ gettestordertemplate(merchantId, templateName) +
Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  templateName: string, The name of the template to retrieve. (required)
+    Allowed values
+      template1 - 
+      template1a - 
+      template1b - 
+      template2 - 
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersGetTestOrderTemplateResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersGetTestOrderTemplateResponse".
+    "template": { # The requested test order template.
+      "customer": { # The details of the customer who placed the order.
+        "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow. Optional.
+        "fullName": "A String", # Full name of the customer.
+        "email": "A String", # Email address of the customer.
+      },
+      "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+        {
+          "benefits": [
+            {
+              "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+                "A String",
+              ],
+              "discount": { # The discount in the order price when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+              "taxImpact": { # The impact on tax when the promotion is applied.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+            },
+          ],
+          "longTitle": "A String", # The full title of the promotion.
+          "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+          "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+          "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+          "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+              # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+          "id": "A String", # The unique ID of the promotion.
+        },
+      ],
+      "kind": "content#testOrder", # Identifies what kind of resource this is. Value: the fixed string "content#testOrder".
+      "shippingCostTax": { # The tax for the total shipping cost.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "predefinedDeliveryAddress": "A String", # Identifier of one of the predefined delivery addresses for the delivery.
+      "shippingCost": { # The total cost of shipping for all items.
+        "currency": "A String", # The currency of the price.
+        "value": "A String", # The price represented as a number.
+      },
+      "shippingOption": "A String", # The requested shipping option.
+      "lineItems": [ # Line items that are ordered. At least one line item must be provided.
+        {
+          "returnInfo": { # Details of the return policy for the line item.
+            "policyUrl": "A String", # URL of the item return policy.
+            "isReturnable": True or False, # Whether the item is returnable.
+            "daysToReturn": 42, # How many days later the item can be returned.
+          },
+          "product": { # Product data from the time of the order placement.
+            "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+            "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+            "title": "A String", # The title of the product.
+            "mpn": "A String", # Manufacturer Part Number (MPN) of the item. Optional.
+            "variantAttributes": [ # Variant attributes for the item. Optional.
+              {
+                "dimension": "A String", # The dimension of the variant.
+                "value": "A String", # The value for the dimension.
+              },
+            ],
+            "brand": "A String", # Brand of the item.
+            "itemGroupId": "A String", # Shared identifier for all variants of the same product. Optional.
+            "offerId": "A String", # An identifier of the item.
+            "imageLink": "A String", # URL of an image of the item.
+            "gtin": "A String", # Global Trade Item Number (GTIN) of the item. Optional.
+            "channel": "A String", # The item's channel.
+            "price": { # The price for the product.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "condition": "A String", # Condition or state of the item.
+          },
+          "unitTax": { # Unit tax for the line item.
+            "currency": "A String", # The currency of the price.
+            "value": "A String", # The price represented as a number.
+          },
+          "quantityOrdered": 42, # Number of items ordered.
+          "shippingDetails": { # Details of the requested shipping for the line item.
+            "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+            "method": { # Details of the shipping method.
+              "minDaysInTransit": 42, # Minimum transit time.
+              "carrier": "A String", # The carrier for the shipping. Optional.
+              "methodName": "A String", # The name of the shipping method.
+              "maxDaysInTransit": 42, # Maximum transit time.
+            },
+            "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+          },
+        },
+      ],
+      "paymentMethod": { # The details of the payment method.
+        "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+        "type": "A String", # The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder.
+        "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+        "lastFourDigits": "A String", # The last four digits of the card number.
+        "predefinedBillingAddress": "A String", # The billing address.
+      },
+    },
+  }
+
+ +
+ list(merchantId, orderBy=None, pageToken=None, placedDateEnd=None, acknowledged=None, maxResults=None, placedDateStart=None, statuses=None) +
Lists the orders in your Merchant Center account.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderBy: string, The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. "placedDate desc" stands for listing orders by placement date, from oldest to most recent. "placedDate asc" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.
+    Allowed values
+      placedDate asc - 
+      placedDate desc - 
+  pageToken: string, The token returned by the previous request.
+  placedDateEnd: string, Obtains orders placed before this date (exclusively), in ISO 8601 format.
+  acknowledged: boolean, Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.
+We recommend using this filter set to false, in conjunction with the acknowledge call, such that only un-acknowledged orders are returned.
+  maxResults: integer, The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.
+Known issue: All List calls will return all Orders without limit regardless of the value of this field.
+  placedDateStart: string, Obtains orders placed after this date (inclusively), in ISO 8601 format.
+  statuses: string, Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled. (repeated)
+    Allowed values
+      active - 
+      canceled - 
+      completed - 
+      delivered - 
+      inProgress - 
+      partiallyDelivered - 
+      partiallyReturned - 
+      partiallyShipped - 
+      pendingShipment - 
+      returned - 
+      shipped - 
+
+Returns:
+  An object of the form:
+
+    {
+    "nextPageToken": "A String", # The token for the retrieval of the next page of orders.
+    "kind": "content#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersListResponse".
+    "resources": [
+      {
+        "customer": { # The details of the customer who placed the order.
+          "explicitMarketingPreference": True or False, # If set, this indicates the user had a choice to opt in or out of providing marketing rights to the merchant. If unset, this indicates the user has already made this choice in a previous purchase, and was thus not shown the marketing right opt in/out checkbox during the Purchases on Google checkout flow.
+          "fullName": "A String", # Full name of the customer.
+          "email": "A String", # Email address of the customer.
+        },
+        "promotions": [ # The details of the merchant provided promotions applied to the order. More details about the program are  here.
+          {
+            "benefits": [
+              {
+                "offerIds": [ # The OfferId(s) that were purchased in this order and map to this specific benefit of the promotion.
+                  "A String",
+                ],
+                "discount": { # The discount in the order price when the promotion is applied.
+                  "currency": "A String", # The currency of the price.
+                  "value": "A String", # The price represented as a number.
+                },
+                "type": "A String", # Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping).
+                "taxImpact": { # The impact on tax when the promotion is applied.
+                  "currency": "A String", # The currency of the price.
+                  "value": "A String", # The price represented as a number.
+                },
+                "subType": "A String", # Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types.
+              },
+            ],
+            "longTitle": "A String", # The full title of the promotion.
+            "genericRedemptionCode": "A String", # Optional. The text code that corresponds to the promotion when applied on the retailer?s website.
+            "redemptionChannel": "A String", # Indicates that the promotion is valid online.
+            "productApplicability": "A String", # Whether the promotion is applicable to all products or only specific products.
+            "effectiveDates": "A String", # The date and time frame when the promotion is active and ready for validation review. Note that the promotion live time may be delayed for a few hours due to the validation review.
+                # Start date and end date are separated by a forward slash (/). The start date is specified by the format (YYYY-MM-DD), followed by the letter ?T?, the time of the day when the sale starts (in Greenwich Mean Time, GMT), followed by an expression of the time zone for the sale. The end date is in the same format.
+            "id": "A String", # The unique ID of the promotion.
+          },
+        ],
+        "kind": "content#order", # Identifies what kind of resource this is. Value: the fixed string "content#order".
+        "shippingCostTax": { # The tax for the total shipping cost.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "shipments": [ # Shipments of the order.
+          {
+            "status": "A String", # The status of the shipment.
+            "creationDate": "A String", # Date on which the shipment has been created, in ISO 8601 format.
+            "carrier": "A String", # The carrier handling the shipment.
+            "trackingId": "A String", # The tracking id for the shipment.
+            "deliveryDate": "A String", # Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delievered
+            "lineItems": [ # The line items that are shipped.
+              {
+                "lineItemId": "A String", # The id of the line item that is shipped.
+                "quantity": 42, # The quantity that is shipped.
+              },
+            ],
+            "id": "A String", # The id of the shipment.
+          },
+        ],
+        "refunds": [ # Refunds for the order.
+          {
+            "amount": { # The amount that is refunded.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+            "reason": "A String", # The reason for the refund.
+            "actor": "A String", # The actor that created the refund.
+            "reasonText": "A String", # The explanation of the reason.
+          },
+        ],
+        "paymentMethod": { # The details of the payment method.
+          "expirationMonth": 42, # The card expiration month (January = 1, February = 2 etc.).
+          "lastFourDigits": "A String", # The last four digits of the card number.
+          "expirationYear": 42, # The card expiration year (4-digit, e.g. 2015).
+          "phoneNumber": "A String", # The billing phone number.
+          "billingAddress": { # The billing address.
+            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+            "country": "A String", # CLDR country code (e.g. "US").
+            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+                # John Smith
+                # 1600 Amphitheatre Parkway
+                # Mountain View, CA, 94043
+                # United States
+              "A String",
+            ],
+            "streetAddress": [ # Street-level part of the address.
+              "A String",
+            ],
+            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+            "recipientName": "A String", # Name of the recipient.
+            "isPostOfficeBox": True or False, # Whether the address is a post office box.
+            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+          },
+          "type": "A String", # The type of instrument (VISA, Mastercard, etc).
+        },
+        "acknowledged": True or False, # Whether the order was acknowledged.
+        "paymentStatus": "A String", # The status of the payment.
+        "merchantId": "A String",
+        "merchantOrderId": "A String", # Merchant-provided id of the order.
+        "shippingOption": "A String", # The requested shipping option.
+        "status": "A String", # The status of the order.
+        "deliveryDetails": { # The details for the delivery.
+          "phoneNumber": "A String", # The phone number of the person receiving the delivery.
+          "address": { # The delivery address
+            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
+            "country": "A String", # CLDR country code (e.g. "US").
+            "fullAddress": [ # Strings representing the lines of the printed label for mailing the order, for example:
+                # John Smith
+                # 1600 Amphitheatre Parkway
+                # Mountain View, CA, 94043
+                # United States
+              "A String",
+            ],
+            "streetAddress": [ # Street-level part of the address.
+              "A String",
+            ],
+            "postalCode": "A String", # Postal Code or ZIP (e.g. "94043").
+            "recipientName": "A String", # Name of the recipient.
+            "isPostOfficeBox": True or False, # Whether the address is a post office box.
+            "region": "A String", # Top-level administrative subdivision of the country (e.g. "CA").
+          },
+        },
+        "placedDate": "A String", # The date when the order was placed, in ISO 8601 format.
+        "shippingCost": { # The total cost of shipping for all items.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "lineItems": [ # Line items that are ordered.
+          {
+            "product": { # Product data from the time of the order placement.
+              "targetCountry": "A String", # The CLDR territory code of the target country of the product.
+              "shownImage": "A String", # URL to the cached image shown to the user when order was placed.
+              "contentLanguage": "A String", # The two-letter ISO 639-1 language code for the item.
+              "title": "A String", # The title of the product.
+              "mpn": "A String", # Manufacturer Part Number (MPN) of the item.
+              "variantAttributes": [ # Variant attributes for the item. These are dimensions of the product, such as color, gender, material, pattern, and size. You can find a comprehensive list of variant attributes here.
+                {
+                  "dimension": "A String", # The dimension of the variant.
+                  "value": "A String", # The value for the dimension.
+                },
+              ],
+              "brand": "A String", # Brand of the item.
+              "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+              "offerId": "A String", # An identifier of the item.
+              "price": { # Price of the item.
+                "currency": "A String", # The currency of the price.
+                "value": "A String", # The price represented as a number.
+              },
+              "imageLink": "A String", # URL of an image of the item.
+              "gtin": "A String", # Global Trade Item Number (GTIN) of the item.
+              "channel": "A String", # The item's channel (online or local).
+              "id": "A String", # The REST id of the product.
+              "condition": "A String", # Condition or state of the item.
+            },
+            "quantityDelivered": 42, # Number of items delivered.
+            "returnInfo": { # Details of the return policy for the line item.
+              "policyUrl": "A String", # URL of the item return policy.
+              "isReturnable": True or False, # Whether the item is returnable.
+              "daysToReturn": 42, # How many days later the item can be returned.
+            },
+            "price": { # Total price for the line item. For example, if two items for $10 are purchased, the total price will be $20.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "quantityPending": 42, # Number of items pending.
+            "tax": { # Total tax amount for the line item. For example, if two items are purchased, and each have a cost tax of $2, the total tax amount will be $4.
+              "currency": "A String", # The currency of the price.
+              "value": "A String", # The price represented as a number.
+            },
+            "cancellations": [ # Cancellations of the line item.
+              {
+                "reason": "A String", # The reason for the cancellation.
+                "creationDate": "A String", # Date on which the cancellation has been created, in ISO 8601 format.
+                "reasonText": "A String", # The explanation of the reason.
+                "actor": "A String", # The actor that created the cancellation.
+                "quantity": 42, # The quantity that was canceled.
+              },
+            ],
+            "quantityCanceled": 42, # Number of items canceled.
+            "quantityOrdered": 42, # Number of items ordered.
+            "returns": [ # Returns of the line item.
+              {
+                "reason": "A String", # The reason for the return.
+                "creationDate": "A String", # Date on which the item has been created, in ISO 8601 format.
+                "reasonText": "A String", # The explanation of the reason.
+                "actor": "A String", # The actor that created the refund.
+                "quantity": 42, # Quantity that is returned.
+              },
+            ],
+            "quantityShipped": 42, # Number of items shipped.
+            "quantityReturned": 42, # Number of items returned.
+            "id": "A String", # The id of the line item.
+            "shippingDetails": { # Details of the requested shipping for the line item.
+              "deliverByDate": "A String", # The delivery by date, in ISO 8601 format.
+              "method": { # Details of the shipping method.
+                "minDaysInTransit": 42, # Minimum transit time.
+                "carrier": "A String", # The carrier for the shipping. Optional.
+                "methodName": "A String", # The name of the shipping method.
+                "maxDaysInTransit": 42, # Maximum transit time.
+              },
+              "shipByDate": "A String", # The ship by date, in ISO 8601 format.
+            },
+          },
+        ],
+        "netAmount": { # The net amount for the order. For example, if an order was originally for a grand total of $100 and a refund was issued for $20, the net amount will be $80.
+          "currency": "A String", # The currency of the price.
+          "value": "A String", # The price represented as a number.
+        },
+        "id": "A String", # The REST id of the order. Globally unique.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ refund(merchantId, orderId, body) +
Refund a portion of the order, up to the full amount paid.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order to refund. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "amount": { # The amount that is refunded.
+      "currency": "A String", # The currency of the price.
+      "value": "A String", # The price represented as a number.
+    },
+    "reasonText": "A String", # The explanation of the reason.
+    "reason": "A String", # The reason for the refund.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersRefundResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersRefundResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ returnlineitem(merchantId, orderId, body) +
Returns a line item.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "reason": "A String", # The reason for the return.
+    "quantity": 42, # The quantity to return.
+    "reasonText": "A String", # The explanation of the reason.
+    "lineItemId": "A String", # The ID of the line item to return.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersReturnLineItemResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersReturnLineItemResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ shiplineitems(merchantId, orderId, body) +
Marks line item(s) as shipped.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "lineItems": [ # Line items to ship.
+      {
+        "lineItemId": "A String", # The id of the line item that is shipped.
+        "quantity": 42, # The quantity that is shipped.
+      },
+    ],
+    "carrier": "A String", # The carrier handling the shipment.
+    "shipmentId": "A String", # The ID of the shipment.
+    "trackingId": "A String", # The tracking id for the shipment.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersShipLineItemsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ updatemerchantorderid(merchantId, orderId, body) +
Updates the merchant order ID for a given order.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "merchantOrderId": "A String", # The merchant order id to be assigned to the order. Must be unique per merchant.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersUpdateMerchantOrderIdResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateMerchantOrderIdResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ +
+ updateshipment(merchantId, orderId, body) +
Updates a shipment's status, carrier, and/or tracking ID.
+
+Args:
+  merchantId: string, The ID of the managing account. (required)
+  orderId: string, The ID of the order. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "status": "A String", # New status for the shipment. Not updated if missing.
+    "shipmentId": "A String", # The ID of the shipment.
+    "carrier": "A String", # The carrier handling the shipment. Not updated if missing.
+    "trackingId": "A String", # The tracking id for the shipment. Not updated if missing.
+    "operationId": "A String", # The ID of the operation. Unique across all operations for a given order.
+  }
+
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "content#ordersUpdateShipmentResponse", # Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
+    "executionStatus": "A String", # The status of the execution.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/content_v2.products.html b/docs/dyn/content_v2.products.html index affa6128ae5..4daaa3608ed 100644 --- a/docs/dyn/content_v2.products.html +++ b/docs/dyn/content_v2.products.html @@ -87,7 +87,7 @@

Instance Methods

insert(merchantId, body, dryRun=None)

Uploads a product to your Merchant Center account.

- list(merchantId, pageToken=None, maxResults=None)

+ list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)

Lists the products in your Merchant Center account.

list_next(previous_request, previous_response)

@@ -116,6 +116,9 @@

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). @@ -331,6 +334,9 @@

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). @@ -544,6 +550,9 @@

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). @@ -741,6 +750,9 @@

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). @@ -933,6 +945,9 @@

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). @@ -1111,11 +1126,12 @@

Method Details

- list(merchantId, pageToken=None, maxResults=None) + list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)
Lists the products in your Merchant Center account.
 
 Args:
   merchantId: string, The ID of the managing account. (required)
+  includeInvalidInsertedItems: boolean, Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
   pageToken: string, The token returned by the previous request.
   maxResults: integer, The maximum number of products to return in the response, used for paging.
 
@@ -1137,6 +1153,9 @@ 

Method Details

"A String", ], "itemGroupId": "A String", # Shared identifier for all variants of the same product. + "promotionIds": [ # The unique ID of a promotion. + "A String", + ], "gtin": "A String", # Global Trade Item Number (GTIN) of the item. "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. "googleProductCategory": "A String", # Google's category of the item (see Google product taxonomy). diff --git a/docs/dyn/content_v2.productstatuses.html b/docs/dyn/content_v2.productstatuses.html index 49a3e6bafc8..3b2cc9647bb 100644 --- a/docs/dyn/content_v2.productstatuses.html +++ b/docs/dyn/content_v2.productstatuses.html @@ -81,7 +81,7 @@

Instance Methods

get(merchantId, productId)

Gets the status of a product from your Merchant Center account.

- list(merchantId, pageToken=None, maxResults=None)

+ list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)

Lists the statuses of the products in your Merchant Center account.

list_next(previous_request, previous_response)

@@ -202,14 +202,14 @@

Method Details

- list(merchantId, pageToken=None, maxResults=None) + list(merchantId, includeInvalidInsertedItems=None, pageToken=None, maxResults=None)
Lists the statuses of the products in your Merchant Center account.
 
 Args:
   merchantId: string, The ID of the managing account. (required)
+  includeInvalidInsertedItems: boolean, Flag to include the invalid inserted items in the result of the list request. By default the invalid items are not shown (the default value is false).
   pageToken: string, The token returned by the previous request.
-  maxResults: integer, The maximum number of product statuses to return in the response, used for paging. The default value is 25 and the maximum allowed value is 250.
-Known issue: Note that for the time being all List calls will return by default all orders without limit.
+  maxResults: integer, The maximum number of product statuses to return in the response, used for paging.
 
 Returns:
   An object of the form:
diff --git a/docs/dyn/dataflow_v1b3.projects.html b/docs/dyn/dataflow_v1b3.projects.html
index 7efde1e23f6..23fa1b1d6e0 100644
--- a/docs/dyn/dataflow_v1b3.projects.html
+++ b/docs/dyn/dataflow_v1b3.projects.html
@@ -79,4 +79,60 @@ 

Instance Methods

Returns the jobs Resource.

+

+ workerMessages(projectId, body, x__xgafv=None)

+

Send a worker_message to the service.

+

Method Details

+
+ workerMessages(projectId, body, x__xgafv=None) +
Send a worker_message to the service.
+
+Args:
+  projectId: string, The project to send the WorkerMessages to. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A request for sending worker messages to the service.
+    "workerMessages": [ # The WorkerMessages to send.
+      { # WorkerMessage provides information to the backend about a worker.
+        "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker.
+          "pods": [ # The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker.
+            {
+              "a_key": "", # Properties of the object.
+            },
+          ],
+          "reportInterval": "A String", # The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker.
+          "vmStartupTime": "A String", # The time the VM was booted.
+          "vmIsHealthy": True or False, # Whether the VM is healthy.
+        },
+        "labels": { # Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
+          "a_key": "A String",
+        },
+        "workerMessageCode": { # A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). # A worker message code.
+          "code": "A String", # The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change.
+          "parameters": { # Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "time": "A String", # The timestamp of the worker_message.
+      },
+    ],
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The response to the worker messages.
+    "workerMessageResponses": [ # The servers response to the worker messages.
+      { # A worker_message response allows the server to pass information to the sender.
+        "workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker in response to a health ping. # The service's response to a worker's health report.
+          "reportInterval": "A String", # A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server.
+        },
+      },
+    ],
+  }
+
+ \ No newline at end of file diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index fa98557ceb1..d26949e0da6 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -177,7 +177,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -189,6 +189,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -222,12 +223,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], @@ -308,7 +312,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -320,6 +324,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -353,12 +358,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], @@ -446,7 +454,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -458,6 +466,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -491,12 +500,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], @@ -626,7 +638,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -638,6 +650,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -671,12 +684,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], @@ -777,7 +793,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -789,6 +805,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -822,12 +839,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], @@ -906,7 +926,7 @@

Method Details

"kind": "A String", # The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". - "zone": "A String", # Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default. + "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. @@ -918,6 +938,7 @@

Method Details

"a_key": "", # Properties of the object. Contains field @ype with type URL. }, "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. + "workerHarnessContainerImage": "A String", # Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. "packages": [ # Packages to be installed on workers. { # Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run. @@ -951,12 +972,15 @@

Method Details

}, ], "currentStateTime": "A String", # The timestamp associated with the current state. + "tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} + "A String", + ], "type": "A String", # The type of dataflow job. "id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job. "currentState": "A String", # The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it. "executionInfo": { # Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job. # Information about how the Dataflow service will actually run the job. "stages": { # A mapping from each stage to the information about that stage. - "a_key": { # Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed. + "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. "stepName": [ # The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage. "A String", ], diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html index 8a77ee811e2..92ea56f81a5 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html @@ -112,7 +112,7 @@

Method Details

"workItems": [ # A list of the leased WorkItems. { # WorkItem represents basic information about a WorkItem to be executed in the cloud. "reportStatusInterval": "A String", # Recommended reporting interval. - "leaseExpireTime": "A String", # Time when the lease on this [Work][] will expire. + "leaseExpireTime": "A String", # Time when the lease on this Work will expire. "seqMapTask": { # Describes a particular function to invoke. # Additional information for SeqMapTask WorkItems. "inputs": [ # Information about each of the inputs. { # Information about a side input of a DoFn or an input of a SeqDoFn. @@ -250,6 +250,35 @@

Method Details

}, ], "partialGroupByKey": { # An instruction that does a partial group-by-key. One input and one output. # Additional information for PartialGroupByKey instructions. + "sideInputs": [ # Zero or more side inputs. + { # Information about a side input of a DoFn or an input of a SeqDoFn. + "sources": [ # The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required. + { # A source that records can be read and decoded from. + "codec": { # The codec to use to decode data read from the source. + "a_key": "", # Properties of the object. + }, + "baseSpecs": [ # While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs). + { + "a_key": "", # Properties of the object. + }, + ], + "spec": { # The source to read from, plus its parameters. + "a_key": "", # Properties of the object. + }, + "doesNotNeedSplitting": True or False, # Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. + "metadata": { # Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc. # Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated. + "infinite": True or False, # Specifies that the size of this source is known to be infinite (this is a streaming source). + "estimatedSizeBytes": "A String", # An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader. + "producesSortedKeys": True or False, # Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order. + }, + }, + ], + "kind": { # How to interpret the source element(s) as a side input value. + "a_key": "", # Properties of the object. + }, + "tag": "A String", # The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo. + }, + ], "input": { # An input of an instruction, as a reference to an output of a producer instruction. # Describes the input to the partial group-by-key instruction. "outputNum": 42, # The output index (origin zero) within the producer. "producerInstructionIndex": 42, # The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask. @@ -355,6 +384,7 @@

Method Details

"configuration": "A String", # Work item-specific configuration as an opaque blob. "streamingSetupTask": { # A task which initializes part of a streaming Dataflow job. # Additional information for StreamingSetupTask WorkItems. "workerHarnessPort": 42, # The TCP port used by the worker to communicate with the Dataflow worker harness. + "drain": True or False, # The user has requested drain. "streamingComputationTopology": { # Global topology of the streaming Dataflow job, including all computations and their sharded locations. # The global topology of the streaming Dataflow job. "computations": [ # The computations associated with a streaming Dataflow job. { # All configuration data for a particular Computation. @@ -437,6 +467,7 @@

Method Details

"userStageToComputationNameMap": { # Maps user stage names to stable computation names. "a_key": "A String", }, + "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages. }, "receiveWorkPort": 42, # The TCP port on which the worker should listen for messages from other streaming computation workers. }, @@ -473,9 +504,9 @@

Method Details

{ # Conveys a worker's progress through the work described by a WorkItem. "reportIndex": "A String", # The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service. "errors": [ # Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed. - { # 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. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. + { # 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. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -693,8 +724,8 @@

Method Details

}, }, }, - "progress": { # A progress measurement of a WorkItem by a worker. # The WorkItem's approximate progress. - "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position within the work to represent a progress. + "progress": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of reported_progress. + "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # Obsolete. "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range. "recordIndex": "A String", # Position is a record index. "byteOffset": "A String", # Position is a byte offset. @@ -705,8 +736,8 @@

Method Details

}, "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). }, - "remainingTime": "A String", # Completion as an estimated time remaining. - "percentComplete": 3.14, # Completion as percentage of the work, from 0.0 (beginning, nothing complete), to 1.0 (end of the work range, entire WorkItem complete). + "remainingTime": "A String", # Obsolete. + "percentComplete": 3.14, # Obsolete. }, "metricUpdates": [ # Worker output metrics (counters) for this WorkItem. { # Describes the state of a metric. @@ -728,6 +759,28 @@

Method Details

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service. }, ], + "reportedProgress": { # A progress measurement of a WorkItem by a worker. # The worker's progress through this WorkItem. + "fractionConsumed": 3.14, # Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed). + "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position within the work to represent a progress. + "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range. + "recordIndex": "A String", # Position is a record index. + "byteOffset": "A String", # Position is a byte offset. + "key": "A String", # Position is a string key, ordered lexicographically. + "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position. + "index": 42, # Index of the inner source. + "position": # Object with schema name: Position # Position within the inner source. + }, + "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). + }, + "remainingParallelism": { # Represents the level of parallelism in a WorkItem's input, reported by the worker. # Total amount of parallelism in the input of this WorkItem that has not been consumed yet (i.e. can be delegated to a new WorkItem via dynamic splitting). "Amount of parallelism" refers to how many non-empty parts of the input can be read in parallel. This does not necessarily equal number of records. An input that can be read in parallel down to the individual records is called "perfectly splittable". An example of non-perfectly parallelizable input is a block-compressed file format where a block of records has to be read as a whole, but different blocks can be read in parallel. Examples: * If we have read 30 records out of 50 in a perfectly splittable 50-record input, this value should be 20. * If we are reading through block 3 in a block-compressed file consisting of 5 blocks, this value should be 2 (since blocks 4 and 5 can be processed in parallel by new work items via dynamic splitting). * If we are reading through the last block in a block-compressed file, or reading or processing the last record in a perfectly splittable input, this value should be 0, because the remainder of the work item cannot be further split. + "isInfinite": True or False, # Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. + "value": 3.14, # Specifies the level of parallelism in case it is finite. + }, + "consumedParallelism": { # Represents the level of parallelism in a WorkItem's input, reported by the worker. # Total amount of parallelism in the portion of input of this work item that has already been consumed. In the first two examples above (see remaining_parallelism), the value should be 30 or 3 respectively. The sum of remaining_parallelism and consumed_parallelism should equal the total amount of parallelism in this work item. If specified, must be finite. + "isInfinite": True or False, # Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack. + "value": 3.14, # Specifies the level of parallelism in case it is finite. + }, + }, }, ], } @@ -757,8 +810,22 @@

Method Details

}, "nextReportIndex": "A String", # The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts. "leaseExpireTime": "A String", # Time at which the current lease will expire. - "suggestedStopPoint": { # A progress measurement of a WorkItem by a worker. # The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task. - "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position within the work to represent a progress. + "splitRequest": { # A suggestion by the service to the worker to dynamically split the WorkItem. # The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task. + "fractionConsumed": 3.14, # A fraction at which to split the work item, from 0.0 (beginning of the input) to 1.0 (end of the input). + "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # A Position at which to split the work item. + "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range. + "recordIndex": "A String", # Position is a record index. + "byteOffset": "A String", # Position is a byte offset. + "key": "A String", # Position is a string key, ordered lexicographically. + "concatPosition": { # A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. # CloudPosition is a concat position. + "index": 42, # Index of the inner source. + "position": # Object with schema name: Position # Position within the inner source. + }, + "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). + }, + }, + "suggestedStopPoint": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of split_request. + "position": { # Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. # Obsolete. "end": True or False, # Position is past all other positions. Also useful for the end position of an unbounded range. "recordIndex": "A String", # Position is a record index. "byteOffset": "A String", # Position is a byte offset. @@ -769,8 +836,8 @@

Method Details

}, "shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). }, - "remainingTime": "A String", # Completion as an estimated time remaining. - "percentComplete": 3.14, # Completion as percentage of the work, from 0.0 (beginning, nothing complete), to 1.0 (end of the work range, entire WorkItem complete). + "remainingTime": "A String", # Obsolete. + "percentComplete": 3.14, # Obsolete. }, }, ], diff --git a/docs/dyn/dataproc_v1.html b/docs/dyn/dataproc_v1.html new file mode 100644 index 00000000000..3166115a369 --- /dev/null +++ b/docs/dyn/dataproc_v1.html @@ -0,0 +1,108 @@ + + + +

Google Cloud Dataproc API

+

Instance Methods

+

+ media() +

+

Returns the media Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.media.html b/docs/dyn/dataproc_v1.media.html new file mode 100644 index 00000000000..68f253d1b61 --- /dev/null +++ b/docs/dyn/dataproc_v1.media.html @@ -0,0 +1,141 @@ + + + +

Google Cloud Dataproc API . media

+

Instance Methods

+

+ download(resourceName, x__xgafv=None)

+

Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.

+

+ download_media(resourceName, x__xgafv=None)

+

Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.

+

+ upload(resourceName, body=None, media_body=None, x__xgafv=None)

+

Method for media upload. Upload is supported on the URI `/upload/v1/media/{+name}`.

+

Method Details

+
+ download(resourceName, x__xgafv=None) +
Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Media resource.
+    "resourceName": "A String", # Name of the media resource.
+  }
+
+ +
+ download_media(resourceName, x__xgafv=None) +
Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ upload(resourceName, body=None, media_body=None, x__xgafv=None) +
Method for media upload. Upload is supported on the URI `/upload/v1/media/{+name}`.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Media resource.
+  "resourceName": "A String", # Name of the media resource.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Media resource.
+    "resourceName": "A String", # Name of the media resource.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.projects.html b/docs/dyn/dataproc_v1.projects.html new file mode 100644 index 00000000000..1b7a76411f4 --- /dev/null +++ b/docs/dyn/dataproc_v1.projects.html @@ -0,0 +1,82 @@ + + + +

Google Cloud Dataproc API . projects

+

Instance Methods

+

+ regions() +

+

Returns the regions Resource.

+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html new file mode 100644 index 00000000000..13e47a92d32 --- /dev/null +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -0,0 +1,687 @@ + + + +

Google Cloud Dataproc API . projects . regions . clusters

+

Instance Methods

+

+ create(projectId, region, body, x__xgafv=None)

+

Creates a cluster in a project.

+

+ delete(projectId, region, clusterName, x__xgafv=None)

+

Deletes a cluster in a project.

+

+ diagnose(projectId, region, clusterName, body, x__xgafv=None)

+

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.

+

+ get(projectId, region, clusterName, x__xgafv=None)

+

Gets the resource representation for a cluster in a project.

+

+ list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all regions/{region}/clusters in a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)

+

Updates a cluster in a project.

+

Method Details

+
+ create(projectId, region, body, x__xgafv=None) +
Creates a cluster in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
+  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+    "state": "A String", # The cluster's state.
+    "stateStartTime": "A String", # Time when this state was entered.
+    "detail": "A String", # Optional details of cluster's state.
+  },
+  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+  "statusHistory": [ # [Output-only] Previous cluster statuses.
+    { # The status of a cluster and its instances.
+      "state": "A String", # The cluster's state.
+      "stateStartTime": "A String", # Time when this state was entered.
+      "detail": "A String", # Optional details of cluster's state.
+    },
+  ],
+  "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
+      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+      "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+        "a_key": "A String",
+      },
+    },
+    "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+    "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine config settings for all instances in a cluster.
+      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+      "tags": [ # The Google Compute Engine tags to add to all instances.
+        "A String",
+      ],
+      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+        "A String",
+      ],
+      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+        "a_key": "A String",
+      },
+    },
+    "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+    "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+      },
+    ],
+    "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+    "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ delete(projectId, region, clusterName, x__xgafv=None) +
Deletes a cluster in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  clusterName: string, [Required] The cluster name. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ diagnose(projectId, region, clusterName, body, x__xgafv=None) +
Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  clusterName: string, [Required] The cluster name. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A request to collect cluster diagnostic information.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ get(projectId, region, clusterName, x__xgafv=None) +
Gets the resource representation for a cluster in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  clusterName: string, [Required] The cluster name. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
+    "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+      "state": "A String", # The cluster's state.
+      "stateStartTime": "A String", # Time when this state was entered.
+      "detail": "A String", # Optional details of cluster's state.
+    },
+    "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+    "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+    "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+    "statusHistory": [ # [Output-only] Previous cluster statuses.
+      { # The status of a cluster and its instances.
+        "state": "A String", # The cluster's state.
+        "stateStartTime": "A String", # Time when this state was entered.
+        "detail": "A String", # Optional details of cluster's state.
+      },
+    ],
+    "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+      "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
+        "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+        "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+          "a_key": "A String",
+        },
+      },
+      "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+      "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine config settings for all instances in a cluster.
+        "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+        "tags": [ # The Google Compute Engine tags to add to all instances.
+          "A String",
+        ],
+        "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+        "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+        "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+          "A String",
+        ],
+        "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+          "a_key": "A String",
+        },
+      },
+      "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
+        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+          "A String",
+        ],
+        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+        },
+        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+        },
+        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+      },
+      "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+          "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+          "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+        },
+      ],
+      "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
+        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+          "A String",
+        ],
+        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+        },
+        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+        },
+        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+      },
+      "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
+        "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+        "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+        "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+          "A String",
+        ],
+        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+          "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+          "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+        },
+        "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+          "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+          "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+        },
+        "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+        "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+      },
+    },
+  }
+
+ +
+ list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all regions/{region}/clusters in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  pageSize: integer, The standard List page size.
+  pageToken: string, The standard List page token.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The list of all clusters in a project.
+    "nextPageToken": "A String", # The standard List next-page token.
+    "clusters": [ # [Output-only] The clusters in the project.
+      { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
+        "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+          "state": "A String", # The cluster's state.
+          "stateStartTime": "A String", # Time when this state was entered.
+          "detail": "A String", # Optional details of cluster's state.
+        },
+        "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+        "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+        "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+        "statusHistory": [ # [Output-only] Previous cluster statuses.
+          { # The status of a cluster and its instances.
+            "state": "A String", # The cluster's state.
+            "stateStartTime": "A String", # Time when this state was entered.
+            "detail": "A String", # Optional details of cluster's state.
+          },
+        ],
+        "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+          "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
+            "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+            "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+              "a_key": "A String",
+            },
+          },
+          "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+          "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine config settings for all instances in a cluster.
+            "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+            "tags": [ # The Google Compute Engine tags to add to all instances.
+              "A String",
+            ],
+            "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+            "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+            "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+              "A String",
+            ],
+            "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+              "a_key": "A String",
+            },
+          },
+          "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
+            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+              "A String",
+            ],
+            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+            },
+            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+            },
+            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+          },
+          "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+            { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+              "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+              "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+            },
+          ],
+          "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
+            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+              "A String",
+            ],
+            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+            },
+            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+            },
+            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+          },
+          "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
+            "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+            "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+            "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+              "A String",
+            ],
+            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+              "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+              "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+            },
+            "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+              "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+              "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+            },
+            "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+            "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+          },
+        },
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None) +
Updates a cluster in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  clusterName: string, [Required] The cluster name. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
+  "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
+    "state": "A String", # The cluster's state.
+    "stateStartTime": "A String", # Time when this state was entered.
+    "detail": "A String", # Optional details of cluster's state.
+  },
+  "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+  "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+  "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
+  "statusHistory": [ # [Output-only] Previous cluster statuses.
+    { # The status of a cluster and its instances.
+      "state": "A String", # The cluster's state.
+      "stateStartTime": "A String", # Time when this state was entered.
+      "detail": "A String", # Optional details of cluster's state.
+    },
+  ],
+  "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
+    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
+      "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
+      "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
+        "a_key": "A String",
+      },
+    },
+    "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
+    "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine config settings for all instances in a cluster.
+      "networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
+      "tags": [ # The Google Compute Engine tags to add to all instances.
+        "A String",
+      ],
+      "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
+      "subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
+      "serviceAccountScopes": [ # The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control
+        "A String",
+      ],
+      "metadata": { # The Google Compute Engine metadata entries to add to all instances.
+        "a_key": "A String",
+      },
+    },
+    "workerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+    "initializationActions": [ # [Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
+      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
+        "executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
+        "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
+      },
+    ],
+    "secondaryWorkerConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+    "masterConfig": { # The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
+      "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
+      "machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
+      "instanceNames": [ # The list of instance names. Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
+        "A String",
+      ],
+      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Disk option config settings.
+        "numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
+        "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
+      },
+      "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+        "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
+        "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
+      },
+      "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
+      "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
+    },
+  },
+}
+
+  updateMask: string, [Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the `PATCH` request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Note: Currently, config.worker_config.num_instances is the only field that can be updated.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.projects.regions.html b/docs/dyn/dataproc_v1.projects.regions.html new file mode 100644 index 00000000000..dedeaf5f2fb --- /dev/null +++ b/docs/dyn/dataproc_v1.projects.regions.html @@ -0,0 +1,92 @@ + + + +

Google Cloud Dataproc API . projects . regions

+

Instance Methods

+

+ clusters() +

+

Returns the clusters Resource.

+ +

+ jobs() +

+

Returns the jobs Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.projects.regions.jobs.html b/docs/dyn/dataproc_v1.projects.regions.jobs.html new file mode 100644 index 00000000000..0b7aa51f608 --- /dev/null +++ b/docs/dyn/dataproc_v1.projects.regions.jobs.html @@ -0,0 +1,1011 @@ + + + +

Google Cloud Dataproc API . projects . regions . jobs

+

Instance Methods

+

+ cancel(projectId, region, jobId, body, x__xgafv=None)

+

Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions/{region}/jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions/{region}/jobs/get).

+

+ delete(projectId, region, jobId, x__xgafv=None)

+

Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.

+

+ get(projectId, region, jobId, x__xgafv=None)

+

Gets the resource representation for a job in a project.

+

+ list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None)

+

Lists regions/{region}/jobs in a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ submit(projectId, region, body, x__xgafv=None)

+

Submits a job to a cluster.

+

Method Details

+
+ cancel(projectId, region, jobId, body, x__xgafv=None) +
Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions/{region}/jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions/{region}/jobs/get).
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  jobId: string, [Required] The job ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A request to cancel a job.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A Cloud Dataproc job resource.
+    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+      "state": "A String", # [Required] A state message specifying the overall job state.
+      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+    },
+    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "statusHistory": [ # [Output-only] The previous job status.
+      { # Cloud Dataproc job status.
+        "state": "A String", # [Required] A state message specifying the overall job state.
+        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+      },
+    ],
+    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
+      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+    },
+    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+    },
+    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+        "a_key": "A String",
+      },
+    },
+    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+        "A String",
+      ],
+      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+        "a_key": "A String",
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+  }
+
+ +
+ delete(projectId, region, jobId, x__xgafv=None) +
Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  jobId: string, [Required] The job ID. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(projectId, region, jobId, x__xgafv=None) +
Gets the resource representation for a job in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  jobId: string, [Required] The job ID. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A Cloud Dataproc job resource.
+    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+      "state": "A String", # [Required] A state message specifying the overall job state.
+      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+    },
+    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "statusHistory": [ # [Output-only] The previous job status.
+      { # Cloud Dataproc job status.
+        "state": "A String", # [Required] A state message specifying the overall job state.
+        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+      },
+    ],
+    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
+      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+    },
+    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+    },
+    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+        "a_key": "A String",
+      },
+    },
+    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+        "A String",
+      ],
+      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+        "a_key": "A String",
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+  }
+
+ +
+ list(projectId, region, pageSize=None, x__xgafv=None, jobStateMatcher=None, pageToken=None, clusterName=None) +
Lists regions/{region}/jobs in a project.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  pageSize: integer, [Optional] The number of results to return in each response.
+  x__xgafv: string, V1 error format.
+  jobStateMatcher: string, [Optional] Specifies enumerated categories of jobs to list.
+  pageToken: string, [Optional] The page token, returned by a previous call, to request the next page of results.
+  clusterName: string, [Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.
+
+Returns:
+  An object of the form:
+
+    { # A list of jobs in a project.
+    "nextPageToken": "A String", # [Optional] This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent ListJobsRequest.
+    "jobs": [ # [Output-only] Jobs list.
+      { # A Cloud Dataproc job resource.
+        "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+          "state": "A String", # [Required] A state message specifying the overall job state.
+          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+        },
+        "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+          "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+            "A String",
+          ],
+          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+              "a_key": "A String",
+            },
+          },
+          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+            "A String",
+          ],
+          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+            "A String",
+          ],
+          "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+            "A String",
+          ],
+          "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+          "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+            "a_key": "A String",
+          },
+        },
+        "statusHistory": [ # [Output-only] The previous job status.
+          { # Cloud Dataproc job status.
+            "state": "A String", # [Required] A state message specifying the overall job state.
+            "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+            "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+          },
+        ],
+        "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
+          "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+          "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+        },
+        "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+          "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+          "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+        },
+        "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+          "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+            "a_key": "A String",
+          },
+          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+              "a_key": "A String",
+            },
+          },
+          "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+            "A String",
+          ],
+          "queryList": { # A list of queries to run on a cluster. # A list of queries.
+            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+              "A String",
+            ],
+          },
+          "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+            "a_key": "A String",
+          },
+        },
+        "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+          "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+            "a_key": "A String",
+          },
+          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+              "a_key": "A String",
+            },
+          },
+          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+            "A String",
+          ],
+          "queryList": { # A list of queries to run on a cluster. # A list of queries.
+            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+              "A String",
+            ],
+          },
+          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+          "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+            "a_key": "A String",
+          },
+        },
+        "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+        "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+        "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+            "A String",
+          ],
+          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+              "a_key": "A String",
+            },
+          },
+          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+            "A String",
+          ],
+          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+            "A String",
+          ],
+          "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+            "A String",
+          ],
+          "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+          "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+            "a_key": "A String",
+          },
+        },
+        "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+          "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+          "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+            "A String",
+          ],
+          "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+            "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+              "a_key": "A String",
+            },
+          },
+          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+            "A String",
+          ],
+          "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+            "A String",
+          ],
+          "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+            "A String",
+          ],
+          "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+            "A String",
+          ],
+          "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+            "a_key": "A String",
+          },
+        },
+        "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+          "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+          "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+            "a_key": "A String",
+          },
+          "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+            "A String",
+          ],
+          "queryList": { # A list of queries to run on a cluster. # A list of queries.
+            "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+              "A String",
+            ],
+          },
+          "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+          "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+            "a_key": "A String",
+          },
+        },
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ submit(projectId, region, body, x__xgafv=None) +
Submits a job to a cluster.
+
+Args:
+  projectId: string, [Required] The ID of the Google Cloud Platform project that the job belongs to. (required)
+  region: string, [Required] The Dataproc region in which to handle the request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A request to submit a job.
+    "job": { # A Cloud Dataproc job resource. # [Required] The job resource.
+      "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+        "state": "A String", # [Required] A state message specifying the overall job state.
+        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+      },
+      "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+        "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+          "A String",
+        ],
+        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+            "a_key": "A String",
+          },
+        },
+        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+          "A String",
+        ],
+        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+          "A String",
+        ],
+        "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+          "A String",
+        ],
+        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+        "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+          "a_key": "A String",
+        },
+      },
+      "statusHistory": [ # [Output-only] The previous job status.
+        { # Cloud Dataproc job status.
+          "state": "A String", # [Required] A state message specifying the overall job state.
+          "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+          "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+        },
+      ],
+      "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
+        "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+        "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+      },
+      "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+        "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+        "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+      },
+      "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+        "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+          "a_key": "A String",
+        },
+        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+            "a_key": "A String",
+          },
+        },
+        "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+          "A String",
+        ],
+        "queryList": { # A list of queries to run on a cluster. # A list of queries.
+          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+            "A String",
+          ],
+        },
+        "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+          "a_key": "A String",
+        },
+      },
+      "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+        "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+          "a_key": "A String",
+        },
+        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+            "a_key": "A String",
+          },
+        },
+        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+          "A String",
+        ],
+        "queryList": { # A list of queries to run on a cluster. # A list of queries.
+          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+            "A String",
+          ],
+        },
+        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+        "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+          "a_key": "A String",
+        },
+      },
+      "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+      "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+      "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+          "A String",
+        ],
+        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+            "a_key": "A String",
+          },
+        },
+        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+          "A String",
+        ],
+        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+          "A String",
+        ],
+        "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+          "A String",
+        ],
+        "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+        "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+          "a_key": "A String",
+        },
+      },
+      "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+        "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+        "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+          "A String",
+        ],
+        "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+          "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+            "a_key": "A String",
+          },
+        },
+        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+          "A String",
+        ],
+        "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+          "A String",
+        ],
+        "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+          "A String",
+        ],
+        "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+          "A String",
+        ],
+        "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+          "a_key": "A String",
+        },
+      },
+      "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+        "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+        "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+          "a_key": "A String",
+        },
+        "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+          "A String",
+        ],
+        "queryList": { # A list of queries to run on a cluster. # A list of queries.
+          "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+            "A String",
+          ],
+        },
+        "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+        "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+          "a_key": "A String",
+        },
+      },
+    },
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A Cloud Dataproc job resource.
+    "status": { # Cloud Dataproc job status. # [Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields.
+      "state": "A String", # [Required] A state message specifying the overall job state.
+      "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+      "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+    },
+    "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+      "jarFileUris": [ # [Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+      "properties": { # [Optional] A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "statusHistory": [ # [Output-only] The previous job status.
+      { # Cloud Dataproc job status.
+        "state": "A String", # [Required] A state message specifying the overall job state.
+        "stateStartTime": "A String", # [Output-only] The time when this state was entered.
+        "details": "A String", # [Optional] Job state details, such as an error description if the state is ERROR.
+      },
+    ],
+    "placement": { # Cloud Dataproc job config. # [Required] Job information, including how, when, and where to run the job.
+      "clusterName": "A String", # [Required] The name of the cluster where the job will be submitted.
+      "clusterUuid": "A String", # [Output-only] A cluster UUID generated by the Dataproc service when the job is submitted.
+    },
+    "reference": { # Encapsulates the full scoping used to reference a job. # [Optional] The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id.
+      "projectId": "A String", # [Required] The ID of the Google Cloud Platform project that the job belongs to.
+      "jobId": "A String", # [Required] The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 512 characters.
+    },
+    "sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
+        "a_key": "A String",
+      },
+    },
+    "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
+        "a_key": "A String",
+      },
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "driverOutputResourceUri": "A String", # [Output-only] A URI pointing to the location of the stdout of the job's driver program.
+    "driverControlFilesUri": "A String", # [Output-only] If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
+    "sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.
+      "properties": { # [Optional] A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
+      "mainPythonFileUri": "A String", # [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
+      "args": [ # [Optional] The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+        "A String",
+      ],
+      "loggingConfig": { # The runtime logging config of the job. # [Optional] The runtime log config for job execution.
+        "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+          "a_key": "A String",
+        },
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+        "A String",
+      ],
+      "fileUris": [ # [Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
+        "A String",
+      ],
+      "archiveUris": [ # [Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
+        "A String",
+      ],
+      "pythonFileUris": [ # [Optional] HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
+        "A String",
+      ],
+      "properties": { # [Optional] A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
+        "a_key": "A String",
+      },
+    },
+    "hiveJob": { # A Cloud Dataproc job for running Hive queries on YARN. # Job is a Hive job.
+      "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
+      "scriptVariables": { # [Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
+        "a_key": "A String",
+      },
+      "jarFileUris": [ # [Optional] HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
+        "A String",
+      ],
+      "queryList": { # A list of queries to run on a cluster. # A list of queries.
+        "queries": [ # [Required] The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
+          "A String",
+        ],
+      },
+      "continueOnFailure": True or False, # [Optional] Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
+      "properties": { # [Optional] A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
+        "a_key": "A String",
+      },
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataproc_v1.projects.regions.operations.html b/docs/dyn/dataproc_v1.projects.regions.operations.html new file mode 100644 index 00000000000..a81557ec41e --- /dev/null +++ b/docs/dyn/dataproc_v1.projects.regions.operations.html @@ -0,0 +1,209 @@ + + + +

Google Cloud Dataproc API . projects . regions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

+ list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(name, x__xgafv=None) +
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+    "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # 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. # The error result of the operation in case of failure.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+    "name": "A String", # 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`.
+    "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ +
+ list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.
+
+Args:
+  name: string, The name of the operation collection. (required)
+  pageSize: integer, The standard list page size.
+  filter: string, The standard list filter.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+    "operations": [ # A list of operations that matches the specified filter in the request.
+      { # This resource represents a long-running operation that is the result of a network API call.
+        "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+        "error": { # 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. # The error result of the operation in case of failure.
+          "message": "A String", # 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.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @ype with type URL.
+            },
+          ],
+        },
+        "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.
+        "name": "A String", # 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`.
+        "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      },
+    ],
+    "nextPageToken": "A String", # The standard List next-page token.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html index b2a884ed2b4..4f03ec88286 100644 --- a/docs/dyn/deploymentmanager_v2.deployments.html +++ b/docs/dyn/deploymentmanager_v2.deployments.html @@ -115,7 +115,7 @@

Method Details

{ "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). # - # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment. + # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. } @@ -123,35 +123,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -161,9 +163,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }
@@ -179,35 +181,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -217,9 +221,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -235,8 +239,20 @@

Method Details

An object of the form: { - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "description": "A String", # An optional user-provided description of the deployment. + "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. + "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. }, "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. @@ -245,35 +261,37 @@

Method Details

# # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -283,9 +301,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. @@ -299,7 +317,7 @@

Method Details

}, }, "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "description": "A String", # An optional user-provided description of the deployment. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } @@ -313,8 +331,20 @@

Method Details

The object takes the form of: { - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "description": "A String", # An optional user-provided description of the deployment. + "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. + "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. }, "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. @@ -323,35 +353,37 @@

Method Details

# # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -361,9 +393,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. @@ -377,7 +409,7 @@

Method Details

}, }, "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "description": "A String", # An optional user-provided description of the deployment. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. @@ -386,35 +418,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -424,9 +458,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -436,13 +470,17 @@

Method Details

Args: project: string, The project ID for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: @@ -451,8 +489,20 @@

Method Details

"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. "deployments": [ # [Output Only] The deployments contained in this response. { - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "description": "A String", # An optional user-provided description of the deployment. + "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. + "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. }, "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. @@ -461,35 +511,37 @@

Method Details

# # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -499,9 +551,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. @@ -515,7 +567,7 @@

Method Details

}, }, "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "description": "A String", # An optional user-provided description of the deployment. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. }, ], } @@ -546,8 +598,20 @@

Method Details

The object takes the form of: { - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "description": "A String", # An optional user-provided description of the deployment. + "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. + "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. }, "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. @@ -556,35 +620,37 @@

Method Details

# # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -594,9 +660,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. @@ -610,7 +676,7 @@

Method Details

}, }, "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "description": "A String", # An optional user-provided description of the deployment. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } deletePolicy: string, Sets the policy to use for deleting resources. @@ -621,41 +687,43 @@

Method Details

Allowed values ACQUIRE - CREATE_OR_ACQUIRE - - preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. + preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -665,9 +733,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -684,7 +752,7 @@

Method Details

{ "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). # - # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request to a deployment. + # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment. } @@ -692,35 +760,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -730,9 +800,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -747,8 +817,20 @@

Method Details

The object takes the form of: { - "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "description": "A String", # An optional user-provided description of the deployment. + "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here. + "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])? Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)? + { + "value": "A String", + "key": "A String", + }, + ], "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment. }, "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed. @@ -757,35 +839,37 @@

Method Details

# # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment. "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -795,9 +879,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates. "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. @@ -811,7 +895,7 @@

Method Details

}, }, "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "description": "A String", # An optional user-provided description of the deployment. + "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. } deletePolicy: string, Sets the policy to use for deleting resources. @@ -822,41 +906,43 @@

Method Details

Allowed values ACQUIRE - CREATE_OR_ACQUIRE - - preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment looks like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. + preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it. Returns: An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -866,9 +952,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } diff --git a/docs/dyn/deploymentmanager_v2.manifests.html b/docs/dyn/deploymentmanager_v2.manifests.html index 710aeaa23ca..aed215452eb 100644 --- a/docs/dyn/deploymentmanager_v2.manifests.html +++ b/docs/dyn/deploymentmanager_v2.manifests.html @@ -122,13 +122,17 @@

Method Details

Args: project: string, The project ID for this request. (required) deployment: string, The name of the deployment for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: diff --git a/docs/dyn/deploymentmanager_v2.operations.html b/docs/dyn/deploymentmanager_v2.operations.html index 0175500c1d0..d446317b24e 100644 --- a/docs/dyn/deploymentmanager_v2.operations.html +++ b/docs/dyn/deploymentmanager_v2.operations.html @@ -96,35 +96,37 @@

Method Details

An object of the form: { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -134,9 +136,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. } @@ -146,13 +148,17 @@

Method Details

Args: project: string, The project ID for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: @@ -161,35 +167,37 @@

Method Details

"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. "operations": [ # [Output Only] Operations contained in this list response. { # An Operation resource, used to manage asynchronous API requests. - "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. - "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "clientOperationId": "A String", # [Output Only] Reserved for future use. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "zone": "A String", # [Output Only] URL of the zone where the operation resides. - "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. - "progress": 42, # [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. - "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404. + "progress": 42, # [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. + "httpErrorStatusCode": 42, # [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. "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. - "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE. - "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, ], "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. - "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format. - "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources. + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. "name": "A String", # [Output Only] Name of the resource. - "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. "errors": [ # [Output Only] The array of errors encountered while processing this operation. { @@ -199,9 +207,9 @@

Method Details

}, ], }, - "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. }, ], } diff --git a/docs/dyn/deploymentmanager_v2.resources.html b/docs/dyn/deploymentmanager_v2.resources.html index 968a37f09bb..5c83b892070 100644 --- a/docs/dyn/deploymentmanager_v2.resources.html +++ b/docs/dyn/deploymentmanager_v2.resources.html @@ -102,12 +102,13 @@

Method Details

"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config. "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, @@ -117,12 +118,13 @@

Method Details

"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML. "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, @@ -156,13 +158,17 @@

Method Details

Args: project: string, The project ID for this request. (required) deployment: string, The name of the deployment for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: @@ -176,12 +182,13 @@

Method Details

"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config. "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, @@ -191,12 +198,13 @@

Method Details

"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML. "warnings": [ # [Output Only] If warning messages are generated during processing of this resource, this field will be populated. { - "message": "A String", # [Output Only] Optional human-readable details for this warning. - "code": "A String", # [Output Only] The warning type identifier for this warning. - "data": [ # [Output Only] Metadata for this warning in key: value format. + "message": "A String", # [Output Only] A human-readable description of the warning code. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ { "key": "scope", "value": "zones/us-east1-d" } { "value": "A String", # [Output Only] A warning data value corresponding to the key. - "key": "A String", # [Output Only] A key for the warning data. + "key": "A String", # [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). }, ], }, diff --git a/docs/dyn/deploymentmanager_v2.types.html b/docs/dyn/deploymentmanager_v2.types.html index 0590ac186ba..4d4c8b4bf1c 100644 --- a/docs/dyn/deploymentmanager_v2.types.html +++ b/docs/dyn/deploymentmanager_v2.types.html @@ -87,13 +87,17 @@

Method Details

Args: project: string, The project ID for this request. (required) - maxResults: integer, Maximum count of results to be returned. - pageToken: string, 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. - filter: string, 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. + maxResults: integer, 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. + pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + filter: string, 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. -The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or 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. +The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. -For example, filter=name ne example-instance. +For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance. + +Compute 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. + +The 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. Returns: An object of the form: diff --git a/docs/dyn/dfareporting_v2_4.accountActiveAdSummaries.html b/docs/dyn/dfareporting_v2_4.accountActiveAdSummaries.html new file mode 100644 index 00000000000..e8082d25833 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.accountActiveAdSummaries.html @@ -0,0 +1,101 @@ + + + +

DCM/DFA Reporting And Trafficking API . accountActiveAdSummaries

+

Instance Methods

+

+ get(profileId, summaryAccountId)

+

Gets the account's active ad summary by account ID.

+

Method Details

+
+ get(profileId, summaryAccountId) +
Gets the account's active ad summary by account ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  summaryAccountId: string, Account ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Gets a summary of active ads in an account.
+    "availableAds": "A String", # Ads that can be activated for the account.
+    "kind": "dfareporting#accountActiveAdSummary", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountActiveAdSummary".
+    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for the account.
+    "activeAds": "A String", # Ads that have been activated for the account
+    "accountId": "A String", # ID of the account.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.accountPermissionGroups.html b/docs/dyn/dfareporting_v2_4.accountPermissionGroups.html new file mode 100644 index 00000000000..30df83e9f2a --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.accountPermissionGroups.html @@ -0,0 +1,124 @@ + + + +

DCM/DFA Reporting And Trafficking API . accountPermissionGroups

+

Instance Methods

+

+ get(profileId, id)

+

Gets one account permission group by ID.

+

+ list(profileId)

+

Retrieves the list of account permission groups.

+

Method Details

+
+ get(profileId, id) +
Gets one account permission group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Account permission group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
+    "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
+    "id": "A String", # ID of this account permission group.
+    "name": "A String", # Name of this account permission group.
+  }
+
+ +
+ list(profileId) +
Retrieves the list of account permission groups.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Account Permission Group List Response
+    "kind": "dfareporting#accountPermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroupsListResponse".
+    "accountPermissionGroups": [ # Account permission group collection.
+      { # AccountPermissionGroups contains a mapping of permission group IDs to names. A permission group is a grouping of account permissions.
+        "kind": "dfareporting#accountPermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionGroup".
+        "id": "A String", # ID of this account permission group.
+        "name": "A String", # Name of this account permission group.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.accountPermissions.html b/docs/dyn/dfareporting_v2_4.accountPermissions.html new file mode 100644 index 00000000000..12d00649e65 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.accountPermissions.html @@ -0,0 +1,142 @@ + + + +

DCM/DFA Reporting And Trafficking API . accountPermissions

+

Instance Methods

+

+ get(profileId, id)

+

Gets one account permission by ID.

+

+ list(profileId)

+

Retrieves the list of account permissions.

+

Method Details

+
+ get(profileId, id) +
Gets one account permission by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Account permission ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
+    "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
+    "name": "A String", # Name of this account permission.
+    "level": "A String", # Administrative level required to enable this account permission.
+    "permissionGroupId": "A String", # Permission group of this account permission.
+    "accountProfiles": [ # Account profiles associated with this account permission.
+        #
+        # Possible values are:
+        # - "ACCOUNT_PROFILE_BASIC"
+        # - "ACCOUNT_PROFILE_STANDARD"
+      "A String",
+    ],
+    "id": "A String", # ID of this account permission.
+  }
+
+ +
+ list(profileId) +
Retrieves the list of account permissions.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Account Permission List Response
+    "accountPermissions": [ # Account permission collection.
+      { # AccountPermissions contains information about a particular account permission. Some features of DCM require an account permission to be present in the account.
+        "kind": "dfareporting#accountPermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermission".
+        "name": "A String", # Name of this account permission.
+        "level": "A String", # Administrative level required to enable this account permission.
+        "permissionGroupId": "A String", # Permission group of this account permission.
+        "accountProfiles": [ # Account profiles associated with this account permission.
+            #
+            # Possible values are:
+            # - "ACCOUNT_PROFILE_BASIC"
+            # - "ACCOUNT_PROFILE_STANDARD"
+          "A String",
+        ],
+        "id": "A String", # ID of this account permission.
+      },
+    ],
+    "kind": "dfareporting#accountPermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountPermissionsListResponse".
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.accountUserProfiles.html b/docs/dyn/dfareporting_v2_4.accountUserProfiles.html new file mode 100644 index 00000000000..2a32cdb2343 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.accountUserProfiles.html @@ -0,0 +1,677 @@ + + + +

DCM/DFA Reporting And Trafficking API . accountUserProfiles

+

Instance Methods

+

+ get(profileId, id)

+

Gets one account user profile by ID.

+

+ insert(profileId, body)

+

Inserts a new account user profile.

+

+ list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None)

+

Retrieves a list of account user profiles, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing account user profile. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing account user profile.

+

Method Details

+
+ get(profileId, id) +
Gets one account user profile by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User profile ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+      "name": "A String", # 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: "&;"#%,".
+      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "locale": "A String", # Locale of the user profile. This is a required field.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "comments": "A String", # Comments for this user profile.
+      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+      "traffickerType": "A String", # Trafficker type of this user profile.
+      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+      "email": "A String", # 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.
+      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new account user profile.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+    "name": "A String", # 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: "&;"#%,".
+    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "locale": "A String", # Locale of the user profile. This is a required field.
+        # Acceptable values are:
+        # - "cs" (Czech)
+        # - "de" (German)
+        # - "en" (English)
+        # - "en-GB" (English United Kingdom)
+        # - "es" (Spanish)
+        # - "fr" (French)
+        # - "it" (Italian)
+        # - "ja" (Japanese)
+        # - "ko" (Korean)
+        # - "pl" (Polish)
+        # - "pt-BR" (Portuguese Brazil)
+        # - "ru" (Russian)
+        # - "sv" (Swedish)
+        # - "tr" (Turkish)
+        # - "zh-CN" (Chinese Simplified)
+        # - "zh-TW" (Chinese Traditional)
+    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "comments": "A String", # Comments for this user profile.
+    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+    "traffickerType": "A String", # Trafficker type of this user profile.
+    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+    "email": "A String", # 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.
+    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+      "name": "A String", # 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: "&;"#%,".
+      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "locale": "A String", # Locale of the user profile. This is a required field.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "comments": "A String", # Comments for this user profile.
+      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+      "traffickerType": "A String", # Trafficker type of this user profile.
+      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+      "email": "A String", # 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.
+      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, subaccountId=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, userRoleId=None, active=None) +
Retrieves a list of account user profiles, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  subaccountId: string, Select only user profiles with the specified subaccount ID.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only user profiles with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  userRoleId: string, Select only user profiles with the specified user role ID.
+  active: boolean, Select only active user profiles.
+
+Returns:
+  An object of the form:
+
+    { # Account User Profile List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "accountUserProfiles": [ # Account user profile collection.
+      { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+          "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+          "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+          "name": "A String", # 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: "&;"#%,".
+          "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+              "A String",
+            ],
+            "status": "A String", # 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.
+            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+          },
+          "locale": "A String", # Locale of the user profile. This is a required field.
+              # Acceptable values are:
+              # - "cs" (Czech)
+              # - "de" (German)
+              # - "en" (English)
+              # - "en-GB" (English United Kingdom)
+              # - "es" (Spanish)
+              # - "fr" (French)
+              # - "it" (Italian)
+              # - "ja" (Japanese)
+              # - "ko" (Korean)
+              # - "pl" (Polish)
+              # - "pt-BR" (Portuguese Brazil)
+              # - "ru" (Russian)
+              # - "sv" (Swedish)
+              # - "tr" (Turkish)
+              # - "zh-CN" (Chinese Simplified)
+              # - "zh-TW" (Chinese Traditional)
+          "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+              "A String",
+            ],
+            "status": "A String", # 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.
+            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+          },
+          "comments": "A String", # Comments for this user profile.
+          "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+          "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+              "A String",
+            ],
+            "status": "A String", # 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.
+            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+          },
+          "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+            "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+              "A String",
+            ],
+            "status": "A String", # 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.
+            "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+          },
+          "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+          "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+          "traffickerType": "A String", # Trafficker type of this user profile.
+          "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+          "email": "A String", # 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.
+          "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#accountUserProfilesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing account user profile. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User profile ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+    "name": "A String", # 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: "&;"#%,".
+    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "locale": "A String", # Locale of the user profile. This is a required field.
+        # Acceptable values are:
+        # - "cs" (Czech)
+        # - "de" (German)
+        # - "en" (English)
+        # - "en-GB" (English United Kingdom)
+        # - "es" (Spanish)
+        # - "fr" (French)
+        # - "it" (Italian)
+        # - "ja" (Japanese)
+        # - "ko" (Korean)
+        # - "pl" (Polish)
+        # - "pt-BR" (Portuguese Brazil)
+        # - "ru" (Russian)
+        # - "sv" (Swedish)
+        # - "tr" (Turkish)
+        # - "zh-CN" (Chinese Simplified)
+        # - "zh-TW" (Chinese Traditional)
+    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "comments": "A String", # Comments for this user profile.
+    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+    "traffickerType": "A String", # Trafficker type of this user profile.
+    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+    "email": "A String", # 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.
+    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+      "name": "A String", # 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: "&;"#%,".
+      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "locale": "A String", # Locale of the user profile. This is a required field.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "comments": "A String", # Comments for this user profile.
+      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+      "traffickerType": "A String", # Trafficker type of this user profile.
+      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+      "email": "A String", # 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.
+      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing account user profile.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+    "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+    "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+    "name": "A String", # 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: "&;"#%,".
+    "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "locale": "A String", # Locale of the user profile. This is a required field.
+        # Acceptable values are:
+        # - "cs" (Czech)
+        # - "de" (German)
+        # - "en" (English)
+        # - "en-GB" (English United Kingdom)
+        # - "es" (Spanish)
+        # - "fr" (French)
+        # - "it" (Italian)
+        # - "ja" (Japanese)
+        # - "ko" (Korean)
+        # - "pl" (Polish)
+        # - "pt-BR" (Portuguese Brazil)
+        # - "ru" (Russian)
+        # - "sv" (Swedish)
+        # - "tr" (Turkish)
+        # - "zh-CN" (Chinese Simplified)
+        # - "zh-TW" (Chinese Traditional)
+    "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "comments": "A String", # Comments for this user profile.
+    "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+    "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+      "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+        "A String",
+      ],
+      "status": "A String", # 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.
+      "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+    },
+    "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+    "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+    "traffickerType": "A String", # Trafficker type of this user profile.
+    "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+    "email": "A String", # 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.
+    "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # AccountUserProfiles contains properties of a DCM user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
+      "kind": "dfareporting#accountUserProfile", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile".
+      "subaccountId": "A String", # Subaccount ID of the user profile. This is a read-only field that can be left blank.
+      "name": "A String", # 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: "&;"#%,".
+      "userRoleFilter": { # Object Filter. # Filter that describes which user roles are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "locale": "A String", # Locale of the user profile. This is a required field.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "siteFilter": { # Object Filter. # Filter that describes which sites are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "comments": "A String", # Comments for this user profile.
+      "id": "A String", # ID of the user profile. This is a read-only, auto-generated field.
+      "advertiserFilter": { # Object Filter. # Filter that describes which advertisers are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "campaignFilter": { # Object Filter. # Filter that describes which campaigns are visible to the user profile.
+        "objectIds": [ # Applicable when status is ASSIGNED. The user has access to objects with these object IDs.
+          "A String",
+        ],
+        "status": "A String", # 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.
+        "kind": "dfareporting#objectFilter", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter".
+      },
+      "userRoleId": "A String", # User role ID of the user profile. This is a required field.
+      "userAccessType": "A String", # User type of the user profile. This is a read-only field that can be left blank.
+      "traffickerType": "A String", # Trafficker type of this user profile.
+      "active": True or False, # Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable.
+      "email": "A String", # 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.
+      "accountId": "A String", # Account ID of the user profile. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.accounts.html b/docs/dyn/dfareporting_v2_4.accounts.html new file mode 100644 index 00000000000..793355ad400 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.accounts.html @@ -0,0 +1,856 @@ + + + +

DCM/DFA Reporting And Trafficking API . accounts

+

Instance Methods

+

+ get(profileId, id)

+

Gets one account by ID.

+

+ list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None)

+

Retrieves the list of accounts, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing account. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing account.

+

Method Details

+
+ get(profileId, id) +
Gets one account by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Account ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM account.
+      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+      "countryId": "A String", # ID of the country associated with this account.
+      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+        "A String",
+      ],
+      "description": "A String", # Description of this account.
+      "maximumImageSize": "A String", # Maximum image size allowed for this account.
+      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+          # Acceptable values are:
+          # - "1" for USD
+          # - "2" for GBP
+          # - "3" for ESP
+          # - "4" for SEK
+          # - "5" for CAD
+          # - "6" for JPY
+          # - "7" for DEM
+          # - "8" for AUD
+          # - "9" for FRF
+          # - "10" for ITL
+          # - "11" for DKK
+          # - "12" for NOK
+          # - "13" for FIM
+          # - "14" for ZAR
+          # - "15" for IEP
+          # - "16" for NLG
+          # - "17" for EUR
+          # - "18" for KRW
+          # - "19" for TWD
+          # - "20" for SGD
+          # - "21" for CNY
+          # - "22" for HKD
+          # - "23" for NZD
+          # - "24" for MYR
+          # - "25" for BRL
+          # - "26" for PTE
+          # - "27" for MXP
+          # - "28" for CLP
+          # - "29" for TRY
+          # - "30" for ARS
+          # - "31" for PEN
+          # - "32" for ILS
+          # - "33" for CHF
+          # - "34" for VEF
+          # - "35" for COP
+          # - "36" for GTQ
+          # - "37" for PLN
+          # - "39" for INR
+          # - "40" for THB
+          # - "41" for IDR
+          # - "42" for CZK
+          # - "43" for RON
+          # - "44" for HUF
+          # - "45" for RUB
+          # - "46" for AED
+          # - "47" for BGN
+          # - "48" for HRK
+      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+      "accountPermissionIds": [ # Account permissions assigned to this account.
+        "A String",
+      ],
+      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+      "locale": "A String", # Locale of this account.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+            # Acceptable values are:
+            #
+            # - "1" for "America/New_York"
+            # - "2" for "Europe/London"
+            # - "3" for "Europe/Paris"
+            # - "4" for "Africa/Johannesburg"
+            # - "5" for "Asia/Jerusalem"
+            # - "6" for "Asia/Shanghai"
+            # - "7" for "Asia/Hong_Kong"
+            # - "8" for "Asia/Tokyo"
+            # - "9" for "Australia/Sydney"
+            # - "10" for "Asia/Dubai"
+            # - "11" for "America/Los_Angeles"
+            # - "12" for "Pacific/Auckland"
+            # - "13" for "America/Sao_Paulo"
+        "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+      },
+      "active": True or False, # Whether this account is active.
+      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+    }
+
+ +
+ list(profileId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None, active=None) +
Retrieves the list of accounts, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only accounts with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  active: boolean, Select only active accounts. Don't set this field to select both active and non-active accounts.
+
+Returns:
+  An object of the form:
+
+    { # Account List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse".
+    "accounts": [ # Account collection.
+      { # Contains properties of a DCM account.
+          "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+          "countryId": "A String", # ID of the country associated with this account.
+          "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+            "A String",
+          ],
+          "description": "A String", # Description of this account.
+          "maximumImageSize": "A String", # Maximum image size allowed for this account.
+          "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+              # Acceptable values are:
+              # - "1" for USD
+              # - "2" for GBP
+              # - "3" for ESP
+              # - "4" for SEK
+              # - "5" for CAD
+              # - "6" for JPY
+              # - "7" for DEM
+              # - "8" for AUD
+              # - "9" for FRF
+              # - "10" for ITL
+              # - "11" for DKK
+              # - "12" for NOK
+              # - "13" for FIM
+              # - "14" for ZAR
+              # - "15" for IEP
+              # - "16" for NLG
+              # - "17" for EUR
+              # - "18" for KRW
+              # - "19" for TWD
+              # - "20" for SGD
+              # - "21" for CNY
+              # - "22" for HKD
+              # - "23" for NZD
+              # - "24" for MYR
+              # - "25" for BRL
+              # - "26" for PTE
+              # - "27" for MXP
+              # - "28" for CLP
+              # - "29" for TRY
+              # - "30" for ARS
+              # - "31" for PEN
+              # - "32" for ILS
+              # - "33" for CHF
+              # - "34" for VEF
+              # - "35" for COP
+              # - "36" for GTQ
+              # - "37" for PLN
+              # - "39" for INR
+              # - "40" for THB
+              # - "41" for IDR
+              # - "42" for CZK
+              # - "43" for RON
+              # - "44" for HUF
+              # - "45" for RUB
+              # - "46" for AED
+              # - "47" for BGN
+              # - "48" for HRK
+          "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+          "accountPermissionIds": [ # Account permissions assigned to this account.
+            "A String",
+          ],
+          "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+          "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+          "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+          "locale": "A String", # Locale of this account.
+              # Acceptable values are:
+              # - "cs" (Czech)
+              # - "de" (German)
+              # - "en" (English)
+              # - "en-GB" (English United Kingdom)
+              # - "es" (Spanish)
+              # - "fr" (French)
+              # - "it" (Italian)
+              # - "ja" (Japanese)
+              # - "ko" (Korean)
+              # - "pl" (Polish)
+              # - "pt-BR" (Portuguese Brazil)
+              # - "ru" (Russian)
+              # - "sv" (Swedish)
+              # - "tr" (Turkish)
+              # - "zh-CN" (Chinese Simplified)
+              # - "zh-TW" (Chinese Traditional)
+          "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+          "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+            "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+                # Acceptable values are:
+                #
+                # - "1" for "America/New_York"
+                # - "2" for "Europe/London"
+                # - "3" for "Europe/Paris"
+                # - "4" for "Africa/Johannesburg"
+                # - "5" for "Asia/Jerusalem"
+                # - "6" for "Asia/Shanghai"
+                # - "7" for "Asia/Hong_Kong"
+                # - "8" for "Asia/Tokyo"
+                # - "9" for "Australia/Sydney"
+                # - "10" for "Asia/Dubai"
+                # - "11" for "America/Los_Angeles"
+                # - "12" for "Pacific/Auckland"
+                # - "13" for "America/Sao_Paulo"
+            "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+              "clickDuration": 42, # 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.
+              "postImpressionActivitiesDuration": 42, # 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.
+            },
+          },
+          "active": True or False, # Whether this account is active.
+          "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+          "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+          "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing account. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Account ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM account.
+    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+    "countryId": "A String", # ID of the country associated with this account.
+    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+      "A String",
+    ],
+    "description": "A String", # Description of this account.
+    "maximumImageSize": "A String", # Maximum image size allowed for this account.
+    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+        # Acceptable values are:
+        # - "1" for USD
+        # - "2" for GBP
+        # - "3" for ESP
+        # - "4" for SEK
+        # - "5" for CAD
+        # - "6" for JPY
+        # - "7" for DEM
+        # - "8" for AUD
+        # - "9" for FRF
+        # - "10" for ITL
+        # - "11" for DKK
+        # - "12" for NOK
+        # - "13" for FIM
+        # - "14" for ZAR
+        # - "15" for IEP
+        # - "16" for NLG
+        # - "17" for EUR
+        # - "18" for KRW
+        # - "19" for TWD
+        # - "20" for SGD
+        # - "21" for CNY
+        # - "22" for HKD
+        # - "23" for NZD
+        # - "24" for MYR
+        # - "25" for BRL
+        # - "26" for PTE
+        # - "27" for MXP
+        # - "28" for CLP
+        # - "29" for TRY
+        # - "30" for ARS
+        # - "31" for PEN
+        # - "32" for ILS
+        # - "33" for CHF
+        # - "34" for VEF
+        # - "35" for COP
+        # - "36" for GTQ
+        # - "37" for PLN
+        # - "39" for INR
+        # - "40" for THB
+        # - "41" for IDR
+        # - "42" for CZK
+        # - "43" for RON
+        # - "44" for HUF
+        # - "45" for RUB
+        # - "46" for AED
+        # - "47" for BGN
+        # - "48" for HRK
+    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+    "accountPermissionIds": [ # Account permissions assigned to this account.
+      "A String",
+    ],
+    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+    "locale": "A String", # Locale of this account.
+        # Acceptable values are:
+        # - "cs" (Czech)
+        # - "de" (German)
+        # - "en" (English)
+        # - "en-GB" (English United Kingdom)
+        # - "es" (Spanish)
+        # - "fr" (French)
+        # - "it" (Italian)
+        # - "ja" (Japanese)
+        # - "ko" (Korean)
+        # - "pl" (Polish)
+        # - "pt-BR" (Portuguese Brazil)
+        # - "ru" (Russian)
+        # - "sv" (Swedish)
+        # - "tr" (Turkish)
+        # - "zh-CN" (Chinese Simplified)
+        # - "zh-TW" (Chinese Traditional)
+    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+          # Acceptable values are:
+          #
+          # - "1" for "America/New_York"
+          # - "2" for "Europe/London"
+          # - "3" for "Europe/Paris"
+          # - "4" for "Africa/Johannesburg"
+          # - "5" for "Asia/Jerusalem"
+          # - "6" for "Asia/Shanghai"
+          # - "7" for "Asia/Hong_Kong"
+          # - "8" for "Asia/Tokyo"
+          # - "9" for "Australia/Sydney"
+          # - "10" for "Asia/Dubai"
+          # - "11" for "America/Los_Angeles"
+          # - "12" for "Pacific/Auckland"
+          # - "13" for "America/Sao_Paulo"
+      "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+    },
+    "active": True or False, # Whether this account is active.
+    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM account.
+      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+      "countryId": "A String", # ID of the country associated with this account.
+      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+        "A String",
+      ],
+      "description": "A String", # Description of this account.
+      "maximumImageSize": "A String", # Maximum image size allowed for this account.
+      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+          # Acceptable values are:
+          # - "1" for USD
+          # - "2" for GBP
+          # - "3" for ESP
+          # - "4" for SEK
+          # - "5" for CAD
+          # - "6" for JPY
+          # - "7" for DEM
+          # - "8" for AUD
+          # - "9" for FRF
+          # - "10" for ITL
+          # - "11" for DKK
+          # - "12" for NOK
+          # - "13" for FIM
+          # - "14" for ZAR
+          # - "15" for IEP
+          # - "16" for NLG
+          # - "17" for EUR
+          # - "18" for KRW
+          # - "19" for TWD
+          # - "20" for SGD
+          # - "21" for CNY
+          # - "22" for HKD
+          # - "23" for NZD
+          # - "24" for MYR
+          # - "25" for BRL
+          # - "26" for PTE
+          # - "27" for MXP
+          # - "28" for CLP
+          # - "29" for TRY
+          # - "30" for ARS
+          # - "31" for PEN
+          # - "32" for ILS
+          # - "33" for CHF
+          # - "34" for VEF
+          # - "35" for COP
+          # - "36" for GTQ
+          # - "37" for PLN
+          # - "39" for INR
+          # - "40" for THB
+          # - "41" for IDR
+          # - "42" for CZK
+          # - "43" for RON
+          # - "44" for HUF
+          # - "45" for RUB
+          # - "46" for AED
+          # - "47" for BGN
+          # - "48" for HRK
+      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+      "accountPermissionIds": [ # Account permissions assigned to this account.
+        "A String",
+      ],
+      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+      "locale": "A String", # Locale of this account.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+            # Acceptable values are:
+            #
+            # - "1" for "America/New_York"
+            # - "2" for "Europe/London"
+            # - "3" for "Europe/Paris"
+            # - "4" for "Africa/Johannesburg"
+            # - "5" for "Asia/Jerusalem"
+            # - "6" for "Asia/Shanghai"
+            # - "7" for "Asia/Hong_Kong"
+            # - "8" for "Asia/Tokyo"
+            # - "9" for "Australia/Sydney"
+            # - "10" for "Asia/Dubai"
+            # - "11" for "America/Los_Angeles"
+            # - "12" for "Pacific/Auckland"
+            # - "13" for "America/Sao_Paulo"
+        "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+      },
+      "active": True or False, # Whether this account is active.
+      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing account.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM account.
+    "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+    "countryId": "A String", # ID of the country associated with this account.
+    "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+      "A String",
+    ],
+    "description": "A String", # Description of this account.
+    "maximumImageSize": "A String", # Maximum image size allowed for this account.
+    "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+        # Acceptable values are:
+        # - "1" for USD
+        # - "2" for GBP
+        # - "3" for ESP
+        # - "4" for SEK
+        # - "5" for CAD
+        # - "6" for JPY
+        # - "7" for DEM
+        # - "8" for AUD
+        # - "9" for FRF
+        # - "10" for ITL
+        # - "11" for DKK
+        # - "12" for NOK
+        # - "13" for FIM
+        # - "14" for ZAR
+        # - "15" for IEP
+        # - "16" for NLG
+        # - "17" for EUR
+        # - "18" for KRW
+        # - "19" for TWD
+        # - "20" for SGD
+        # - "21" for CNY
+        # - "22" for HKD
+        # - "23" for NZD
+        # - "24" for MYR
+        # - "25" for BRL
+        # - "26" for PTE
+        # - "27" for MXP
+        # - "28" for CLP
+        # - "29" for TRY
+        # - "30" for ARS
+        # - "31" for PEN
+        # - "32" for ILS
+        # - "33" for CHF
+        # - "34" for VEF
+        # - "35" for COP
+        # - "36" for GTQ
+        # - "37" for PLN
+        # - "39" for INR
+        # - "40" for THB
+        # - "41" for IDR
+        # - "42" for CZK
+        # - "43" for RON
+        # - "44" for HUF
+        # - "45" for RUB
+        # - "46" for AED
+        # - "47" for BGN
+        # - "48" for HRK
+    "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+    "accountPermissionIds": [ # Account permissions assigned to this account.
+      "A String",
+    ],
+    "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+    "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+    "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+    "locale": "A String", # Locale of this account.
+        # Acceptable values are:
+        # - "cs" (Czech)
+        # - "de" (German)
+        # - "en" (English)
+        # - "en-GB" (English United Kingdom)
+        # - "es" (Spanish)
+        # - "fr" (French)
+        # - "it" (Italian)
+        # - "ja" (Japanese)
+        # - "ko" (Korean)
+        # - "pl" (Polish)
+        # - "pt-BR" (Portuguese Brazil)
+        # - "ru" (Russian)
+        # - "sv" (Swedish)
+        # - "tr" (Turkish)
+        # - "zh-CN" (Chinese Simplified)
+        # - "zh-TW" (Chinese Traditional)
+    "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+    "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+      "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+          # Acceptable values are:
+          #
+          # - "1" for "America/New_York"
+          # - "2" for "Europe/London"
+          # - "3" for "Europe/Paris"
+          # - "4" for "Africa/Johannesburg"
+          # - "5" for "Asia/Jerusalem"
+          # - "6" for "Asia/Shanghai"
+          # - "7" for "Asia/Hong_Kong"
+          # - "8" for "Asia/Tokyo"
+          # - "9" for "Australia/Sydney"
+          # - "10" for "Asia/Dubai"
+          # - "11" for "America/Los_Angeles"
+          # - "12" for "Pacific/Auckland"
+          # - "13" for "America/Sao_Paulo"
+      "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+    },
+    "active": True or False, # Whether this account is active.
+    "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+    "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+    "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM account.
+      "kind": "dfareporting#account", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
+      "countryId": "A String", # ID of the country associated with this account.
+      "availablePermissionIds": [ # User role permissions available to the user roles of this account.
+        "A String",
+      ],
+      "description": "A String", # Description of this account.
+      "maximumImageSize": "A String", # Maximum image size allowed for this account.
+      "currencyId": "A String", # ID of currency associated with this account. This is a required field.
+          # Acceptable values are:
+          # - "1" for USD
+          # - "2" for GBP
+          # - "3" for ESP
+          # - "4" for SEK
+          # - "5" for CAD
+          # - "6" for JPY
+          # - "7" for DEM
+          # - "8" for AUD
+          # - "9" for FRF
+          # - "10" for ITL
+          # - "11" for DKK
+          # - "12" for NOK
+          # - "13" for FIM
+          # - "14" for ZAR
+          # - "15" for IEP
+          # - "16" for NLG
+          # - "17" for EUR
+          # - "18" for KRW
+          # - "19" for TWD
+          # - "20" for SGD
+          # - "21" for CNY
+          # - "22" for HKD
+          # - "23" for NZD
+          # - "24" for MYR
+          # - "25" for BRL
+          # - "26" for PTE
+          # - "27" for MXP
+          # - "28" for CLP
+          # - "29" for TRY
+          # - "30" for ARS
+          # - "31" for PEN
+          # - "32" for ILS
+          # - "33" for CHF
+          # - "34" for VEF
+          # - "35" for COP
+          # - "36" for GTQ
+          # - "37" for PLN
+          # - "39" for INR
+          # - "40" for THB
+          # - "41" for IDR
+          # - "42" for CZK
+          # - "43" for RON
+          # - "44" for HUF
+          # - "45" for RUB
+          # - "46" for AED
+          # - "47" for BGN
+          # - "48" for HRK
+      "defaultCreativeSizeId": "A String", # Default placement dimensions for this account.
+      "accountPermissionIds": [ # Account permissions assigned to this account.
+        "A String",
+      ],
+      "comscoreVceEnabled": True or False, # Whether campaigns created in this account will be enabled for comScore vCE by default.
+      "nielsenOcrEnabled": True or False, # Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
+      "accountProfile": "A String", # Profile for this account. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
+      "locale": "A String", # Locale of this account.
+          # Acceptable values are:
+          # - "cs" (Czech)
+          # - "de" (German)
+          # - "en" (English)
+          # - "en-GB" (English United Kingdom)
+          # - "es" (Spanish)
+          # - "fr" (French)
+          # - "it" (Italian)
+          # - "ja" (Japanese)
+          # - "ko" (Korean)
+          # - "pl" (Polish)
+          # - "pt-BR" (Portuguese Brazil)
+          # - "ru" (Russian)
+          # - "sv" (Swedish)
+          # - "tr" (Turkish)
+          # - "zh-CN" (Chinese Simplified)
+          # - "zh-TW" (Chinese Traditional)
+      "teaserSizeLimit": "A String", # File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240.
+      "reportsConfiguration": { # Reporting Configuration # Reporting configuration of this account.
+        "reportGenerationTimeZoneId": "A String", # Report generation time zone ID of this account. This is a required field that can only be changed by a superuser.
+            # Acceptable values are:
+            #
+            # - "1" for "America/New_York"
+            # - "2" for "Europe/London"
+            # - "3" for "Europe/Paris"
+            # - "4" for "Africa/Johannesburg"
+            # - "5" for "Asia/Jerusalem"
+            # - "6" for "Asia/Shanghai"
+            # - "7" for "Asia/Hong_Kong"
+            # - "8" for "Asia/Tokyo"
+            # - "9" for "Australia/Sydney"
+            # - "10" for "Asia/Dubai"
+            # - "11" for "America/Los_Angeles"
+            # - "12" for "Pacific/Auckland"
+            # - "13" for "America/Sao_Paulo"
+        "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Default lookback windows for new advertisers in this account.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+      },
+      "active": True or False, # Whether this account is active.
+      "activeViewOptOut": True or False, # Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
+      "id": "A String", # ID of this account. This is a read-only, auto-generated field.
+      "activeAdsLimitTier": "A String", # Maximum number of active ads allowed for this account.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.ads.html b/docs/dyn/dfareporting_v2_4.ads.html new file mode 100644 index 00000000000..b6ed0d3db96 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.ads.html @@ -0,0 +1,2832 @@ + + + +

DCM/DFA Reporting And Trafficking API . ads

+

Instance Methods

+

+ get(profileId, id)

+

Gets one ad by ID.

+

+ insert(profileId, body)

+

Inserts a new ad.

+

+ list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None)

+

Retrieves a list of ads, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing ad. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing ad.

+

Method Details

+
+ get(profileId, id) +
Gets one ad by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Ad ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM ad.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+        "countries": [ # 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.
+          { # Contains information about a country that can be targeted by ads.
+            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+            "countryCode": "A String", # Country code.
+            "name": "A String", # Name of this country.
+          },
+        ],
+        "excludeCountries": True or False, # 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.
+        "postalCodes": [ # 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.
+          { # Contains information about a postal code that can be targeted by ads.
+            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+            "code": "A String", # Postal code. This is equivalent to the id field.
+            "id": "A String", # ID of this postal code.
+            "countryCode": "A String", # Country code of the country to which this postal code belongs.
+          },
+        ],
+        "regions": [ # 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.
+          { # Contains information about a region that can be targeted by ads.
+            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+            "countryDartId": "A String", # DART ID of the country to which this region belongs.
+            "name": "A String", # Name of this region.
+            "countryCode": "A String", # Country code of the country to which this region belongs.
+            "regionCode": "A String", # Region code.
+            "dartId": "A String", # DART ID of this region.
+          },
+        ],
+        "cities": [ # 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.
+          { # Contains information about a city that can be targeted by ads.
+            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+            "countryDartId": "A String", # DART ID of the country to which this city belongs.
+            "name": "A String", # Name of this city.
+            "countryCode": "A String", # Country code of the country to which this city belongs.
+            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+            "regionCode": "A String", # Region code of the region to which this city belongs.
+            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+            "regionDartId": "A String", # DART ID of the region to which this city belongs.
+          },
+        ],
+        "metros": [ # 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.
+          { # Contains information about a metro region that can be targeted by ads.
+            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+            "name": "A String", # Name of this metro region.
+            "countryCode": "A String", # Country code of the country to which this metro region belongs.
+            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+            "dartId": "A String", # DART ID of this metro region.
+          },
+        ],
+      },
+      "creativeGroupAssignments": [ # 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.
+        { # Creative Group Assignment.
+          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+          "creativeGroupId": "A String", # ID of the creative group to be assigned.
+        },
+      ],
+      "deliverySchedule": { # Delivery Schedule. # 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.
+        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+        "hardCutoff": True or False, # 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.
+        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+        },
+        "impressionRatio": "A String", # 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.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Event tag overrides for this ad.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this ad is archived.
+      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "platformTypes": [ # 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.
+          { # Contains information about a platform type that can be targeted by ads.
+            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+            "id": "A String", # ID of this platform type.
+            "name": "A String", # Name of this platform type.
+          },
+        ],
+        "operatingSystemVersions": [ # 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.
+          { # Contains information about a particular version of an operating system that can be targeted by ads.
+            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+            "name": "A String", # Name of this operating system version.
+            "id": "A String", # ID of this operating system version.
+            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+              "mobile": True or False, # Whether this operating system is for mobile.
+              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+              "name": "A String", # Name of this operating system.
+              "desktop": True or False, # Whether this operating system is for desktop.
+            },
+            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+          },
+        ],
+        "browsers": [ # 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.
+          { # Contains information about a browser that can be targeted by ads.
+            "majorVersion": "A String", # 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.
+            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+            "name": "A String", # Name of this browser.
+            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+            "minorVersion": "A String", # 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.
+          },
+        ],
+        "operatingSystems": [ # 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.
+          { # Contains information about an operating system that can be targeted by ads.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+        ],
+        "mobileCarriers": [ # 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.
+          { # Contains information about a mobile carrier that can be targeted by ads.
+            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+            "id": "A String", # ID of this mobile carrier.
+            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+            "name": "A String", # Name of this mobile carrier.
+          },
+        ],
+        "connectionTypes": [ # 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.
+          { # 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.
+            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+            "id": "A String", # ID of this connection type.
+            "name": "A String", # Name of this connection type.
+          },
+        ],
+      },
+      "creativeRotation": { # Creative Rotation. # 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.
+        "creativeAssignments": [ # Creative assignments in this creative rotation.
+          { # Creative Assignment.
+            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+            "applyEventTags": True or False, # 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.
+            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+                # Applicable when the creative type is any of the following:
+                # - RICH_MEDIA_INPAGE
+                # - RICH_MEDIA_INPAGE_FLOATING
+                # - RICH_MEDIA_IM_EXPAND
+                # - RICH_MEDIA_EXPANDING
+                # - RICH_MEDIA_INTERSTITIAL_FLOAT
+                # - RICH_MEDIA_MOBILE_IN_APP
+                # - RICH_MEDIA_MULTI_FLOATING
+                # - RICH_MEDIA_PEEL_DOWN
+                # - ADVANCED_BANNER
+                # - VPAID_LINEAR
+                # - VPAID_NON_LINEAR
+              { # Rich Media Exit Override.
+                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+              },
+            ],
+            "sslCompliant": True or False, # 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.
+            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+              { # Creative Group Assignment.
+                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+                "creativeGroupId": "A String", # ID of the creative group to be assigned.
+              },
+            ],
+            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+              { # Companion Click-through override.
+                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                },
+                "creativeId": "A String", # ID of the creative for this companion click-through override.
+              },
+            ],
+            "startTime": "A String", # Date and time that the assigned creative should start serving.
+            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+            },
+            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          },
+        ],
+        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+        "creativeOptimizationConfigurationId": "A String", # 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.
+        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+      },
+      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+      },
+      "comments": "A String", # Comments for this ad.
+      "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+        "expression": "A String", # Expression describing which lists are being targeted by the ad.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # 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).
+      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "expression": "A String", # Keyword expression being targeted by the ad.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "startTime": "A String", # 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.
+      "active": True or False, # Whether this ad is active.
+      "compatibility": "A String", # 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.
+      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+        "hoursOfDay": [ # 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.
+          42,
+        ],
+        "daysOfWeek": [ # Days of the week when the ad will serve.
+            #
+            # Acceptable values are:
+            # - "SUNDAY"
+            # - "MONDAY"
+            # - "TUESDAY"
+            # - "WEDNESDAY"
+            # - "THURSDAY"
+            # - "FRIDAY"
+            # - "SATURDAY"
+          "A String",
+        ],
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "placementAssignments": [ # Placement assignments for this ad.
+        { # Placement Assignment.
+          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+          "sslRequired": True or False, # 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.
+        },
+      ],
+      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+      "dynamicClickTracker": True or False, # 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.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new ad.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM ad.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+      "countries": [ # 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.
+        { # Contains information about a country that can be targeted by ads.
+          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+          "countryCode": "A String", # Country code.
+          "name": "A String", # Name of this country.
+        },
+      ],
+      "excludeCountries": True or False, # 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.
+      "postalCodes": [ # 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.
+        { # Contains information about a postal code that can be targeted by ads.
+          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+          "code": "A String", # Postal code. This is equivalent to the id field.
+          "id": "A String", # ID of this postal code.
+          "countryCode": "A String", # Country code of the country to which this postal code belongs.
+        },
+      ],
+      "regions": [ # 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.
+        { # Contains information about a region that can be targeted by ads.
+          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+          "countryDartId": "A String", # DART ID of the country to which this region belongs.
+          "name": "A String", # Name of this region.
+          "countryCode": "A String", # Country code of the country to which this region belongs.
+          "regionCode": "A String", # Region code.
+          "dartId": "A String", # DART ID of this region.
+        },
+      ],
+      "cities": [ # 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.
+        { # Contains information about a city that can be targeted by ads.
+          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+          "countryDartId": "A String", # DART ID of the country to which this city belongs.
+          "name": "A String", # Name of this city.
+          "countryCode": "A String", # Country code of the country to which this city belongs.
+          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+          "regionCode": "A String", # Region code of the region to which this city belongs.
+          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+          "regionDartId": "A String", # DART ID of the region to which this city belongs.
+        },
+      ],
+      "metros": [ # 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.
+        { # Contains information about a metro region that can be targeted by ads.
+          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+          "name": "A String", # Name of this metro region.
+          "countryCode": "A String", # Country code of the country to which this metro region belongs.
+          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+          "dartId": "A String", # DART ID of this metro region.
+        },
+      ],
+    },
+    "creativeGroupAssignments": [ # 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.
+      { # Creative Group Assignment.
+        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+        "creativeGroupId": "A String", # ID of the creative group to be assigned.
+      },
+    ],
+    "deliverySchedule": { # Delivery Schedule. # 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.
+      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+      "hardCutoff": True or False, # 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.
+      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+      },
+      "impressionRatio": "A String", # 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.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Event tag overrides for this ad.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this ad is archived.
+    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "platformTypes": [ # 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.
+        { # Contains information about a platform type that can be targeted by ads.
+          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+          "id": "A String", # ID of this platform type.
+          "name": "A String", # Name of this platform type.
+        },
+      ],
+      "operatingSystemVersions": [ # 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.
+        { # Contains information about a particular version of an operating system that can be targeted by ads.
+          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+          "name": "A String", # Name of this operating system version.
+          "id": "A String", # ID of this operating system version.
+          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+        },
+      ],
+      "browsers": [ # 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.
+        { # Contains information about a browser that can be targeted by ads.
+          "majorVersion": "A String", # 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.
+          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+          "name": "A String", # Name of this browser.
+          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+          "minorVersion": "A String", # 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.
+        },
+      ],
+      "operatingSystems": [ # 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.
+        { # Contains information about an operating system that can be targeted by ads.
+          "mobile": True or False, # Whether this operating system is for mobile.
+          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+          "name": "A String", # Name of this operating system.
+          "desktop": True or False, # Whether this operating system is for desktop.
+        },
+      ],
+      "mobileCarriers": [ # 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.
+        { # Contains information about a mobile carrier that can be targeted by ads.
+          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+          "id": "A String", # ID of this mobile carrier.
+          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+          "name": "A String", # Name of this mobile carrier.
+        },
+      ],
+      "connectionTypes": [ # 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.
+        { # 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.
+          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+          "id": "A String", # ID of this connection type.
+          "name": "A String", # Name of this connection type.
+        },
+      ],
+    },
+    "creativeRotation": { # Creative Rotation. # 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.
+      "creativeAssignments": [ # Creative assignments in this creative rotation.
+        { # Creative Assignment.
+          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+          "applyEventTags": True or False, # 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.
+          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+              # Applicable when the creative type is any of the following:
+              # - RICH_MEDIA_INPAGE
+              # - RICH_MEDIA_INPAGE_FLOATING
+              # - RICH_MEDIA_IM_EXPAND
+              # - RICH_MEDIA_EXPANDING
+              # - RICH_MEDIA_INTERSTITIAL_FLOAT
+              # - RICH_MEDIA_MOBILE_IN_APP
+              # - RICH_MEDIA_MULTI_FLOATING
+              # - RICH_MEDIA_PEEL_DOWN
+              # - ADVANCED_BANNER
+              # - VPAID_LINEAR
+              # - VPAID_NON_LINEAR
+            { # Rich Media Exit Override.
+              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+            },
+          ],
+          "sslCompliant": True or False, # 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.
+          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+            { # Creative Group Assignment.
+              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+              "creativeGroupId": "A String", # ID of the creative group to be assigned.
+            },
+          ],
+          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+            { # Companion Click-through override.
+              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+              },
+              "creativeId": "A String", # ID of the creative for this companion click-through override.
+            },
+          ],
+          "startTime": "A String", # Date and time that the assigned creative should start serving.
+          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+          },
+          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+      "creativeOptimizationConfigurationId": "A String", # 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.
+      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+    },
+    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+    },
+    "comments": "A String", # Comments for this ad.
+    "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+      "expression": "A String", # Expression describing which lists are being targeted by the ad.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # 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).
+    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "expression": "A String", # Keyword expression being targeted by the ad.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "startTime": "A String", # 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.
+    "active": True or False, # Whether this ad is active.
+    "compatibility": "A String", # 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.
+    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+      "hoursOfDay": [ # 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.
+        42,
+      ],
+      "daysOfWeek": [ # Days of the week when the ad will serve.
+          #
+          # Acceptable values are:
+          # - "SUNDAY"
+          # - "MONDAY"
+          # - "TUESDAY"
+          # - "WEDNESDAY"
+          # - "THURSDAY"
+          # - "FRIDAY"
+          # - "SATURDAY"
+        "A String",
+      ],
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "placementAssignments": [ # Placement assignments for this ad.
+      { # Placement Assignment.
+        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+        "sslRequired": True or False, # 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.
+      },
+    ],
+    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+    "dynamicClickTracker": True or False, # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM ad.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+        "countries": [ # 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.
+          { # Contains information about a country that can be targeted by ads.
+            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+            "countryCode": "A String", # Country code.
+            "name": "A String", # Name of this country.
+          },
+        ],
+        "excludeCountries": True or False, # 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.
+        "postalCodes": [ # 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.
+          { # Contains information about a postal code that can be targeted by ads.
+            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+            "code": "A String", # Postal code. This is equivalent to the id field.
+            "id": "A String", # ID of this postal code.
+            "countryCode": "A String", # Country code of the country to which this postal code belongs.
+          },
+        ],
+        "regions": [ # 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.
+          { # Contains information about a region that can be targeted by ads.
+            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+            "countryDartId": "A String", # DART ID of the country to which this region belongs.
+            "name": "A String", # Name of this region.
+            "countryCode": "A String", # Country code of the country to which this region belongs.
+            "regionCode": "A String", # Region code.
+            "dartId": "A String", # DART ID of this region.
+          },
+        ],
+        "cities": [ # 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.
+          { # Contains information about a city that can be targeted by ads.
+            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+            "countryDartId": "A String", # DART ID of the country to which this city belongs.
+            "name": "A String", # Name of this city.
+            "countryCode": "A String", # Country code of the country to which this city belongs.
+            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+            "regionCode": "A String", # Region code of the region to which this city belongs.
+            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+            "regionDartId": "A String", # DART ID of the region to which this city belongs.
+          },
+        ],
+        "metros": [ # 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.
+          { # Contains information about a metro region that can be targeted by ads.
+            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+            "name": "A String", # Name of this metro region.
+            "countryCode": "A String", # Country code of the country to which this metro region belongs.
+            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+            "dartId": "A String", # DART ID of this metro region.
+          },
+        ],
+      },
+      "creativeGroupAssignments": [ # 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.
+        { # Creative Group Assignment.
+          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+          "creativeGroupId": "A String", # ID of the creative group to be assigned.
+        },
+      ],
+      "deliverySchedule": { # Delivery Schedule. # 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.
+        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+        "hardCutoff": True or False, # 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.
+        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+        },
+        "impressionRatio": "A String", # 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.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Event tag overrides for this ad.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this ad is archived.
+      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "platformTypes": [ # 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.
+          { # Contains information about a platform type that can be targeted by ads.
+            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+            "id": "A String", # ID of this platform type.
+            "name": "A String", # Name of this platform type.
+          },
+        ],
+        "operatingSystemVersions": [ # 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.
+          { # Contains information about a particular version of an operating system that can be targeted by ads.
+            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+            "name": "A String", # Name of this operating system version.
+            "id": "A String", # ID of this operating system version.
+            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+              "mobile": True or False, # Whether this operating system is for mobile.
+              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+              "name": "A String", # Name of this operating system.
+              "desktop": True or False, # Whether this operating system is for desktop.
+            },
+            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+          },
+        ],
+        "browsers": [ # 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.
+          { # Contains information about a browser that can be targeted by ads.
+            "majorVersion": "A String", # 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.
+            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+            "name": "A String", # Name of this browser.
+            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+            "minorVersion": "A String", # 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.
+          },
+        ],
+        "operatingSystems": [ # 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.
+          { # Contains information about an operating system that can be targeted by ads.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+        ],
+        "mobileCarriers": [ # 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.
+          { # Contains information about a mobile carrier that can be targeted by ads.
+            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+            "id": "A String", # ID of this mobile carrier.
+            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+            "name": "A String", # Name of this mobile carrier.
+          },
+        ],
+        "connectionTypes": [ # 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.
+          { # 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.
+            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+            "id": "A String", # ID of this connection type.
+            "name": "A String", # Name of this connection type.
+          },
+        ],
+      },
+      "creativeRotation": { # Creative Rotation. # 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.
+        "creativeAssignments": [ # Creative assignments in this creative rotation.
+          { # Creative Assignment.
+            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+            "applyEventTags": True or False, # 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.
+            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+                # Applicable when the creative type is any of the following:
+                # - RICH_MEDIA_INPAGE
+                # - RICH_MEDIA_INPAGE_FLOATING
+                # - RICH_MEDIA_IM_EXPAND
+                # - RICH_MEDIA_EXPANDING
+                # - RICH_MEDIA_INTERSTITIAL_FLOAT
+                # - RICH_MEDIA_MOBILE_IN_APP
+                # - RICH_MEDIA_MULTI_FLOATING
+                # - RICH_MEDIA_PEEL_DOWN
+                # - ADVANCED_BANNER
+                # - VPAID_LINEAR
+                # - VPAID_NON_LINEAR
+              { # Rich Media Exit Override.
+                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+              },
+            ],
+            "sslCompliant": True or False, # 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.
+            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+              { # Creative Group Assignment.
+                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+                "creativeGroupId": "A String", # ID of the creative group to be assigned.
+              },
+            ],
+            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+              { # Companion Click-through override.
+                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                },
+                "creativeId": "A String", # ID of the creative for this companion click-through override.
+              },
+            ],
+            "startTime": "A String", # Date and time that the assigned creative should start serving.
+            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+            },
+            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          },
+        ],
+        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+        "creativeOptimizationConfigurationId": "A String", # 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.
+        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+      },
+      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+      },
+      "comments": "A String", # Comments for this ad.
+      "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+        "expression": "A String", # Expression describing which lists are being targeted by the ad.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # 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).
+      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "expression": "A String", # Keyword expression being targeted by the ad.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "startTime": "A String", # 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.
+      "active": True or False, # Whether this ad is active.
+      "compatibility": "A String", # 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.
+      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+        "hoursOfDay": [ # 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.
+          42,
+        ],
+        "daysOfWeek": [ # Days of the week when the ad will serve.
+            #
+            # Acceptable values are:
+            # - "SUNDAY"
+            # - "MONDAY"
+            # - "TUESDAY"
+            # - "WEDNESDAY"
+            # - "THURSDAY"
+            # - "FRIDAY"
+            # - "SATURDAY"
+          "A String",
+        ],
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "placementAssignments": [ # Placement assignments for this ad.
+        { # Placement Assignment.
+          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+          "sslRequired": True or False, # 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.
+        },
+      ],
+      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+      "dynamicClickTracker": True or False, # 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.
+    }
+
+ +
+ list(profileId, landingPageIds=None, overriddenEventTagId=None, campaignIds=None, sizeIds=None, archived=None, creativeOptimizationConfigurationIds=None, sslCompliant=None, pageToken=None, sortOrder=None, type=None, sslRequired=None, creativeIds=None, remarketingListIds=None, maxResults=None, creativeType=None, placementIds=None, active=None, compatibility=None, advertiserId=None, searchString=None, audienceSegmentIds=None, ids=None, sortField=None, dynamicClickTracker=None) +
Retrieves a list of ads, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  landingPageIds: string, Select only ads with these landing page IDs. (repeated)
+  overriddenEventTagId: string, Select only ads with this event tag override ID.
+  campaignIds: string, Select only ads with these campaign IDs. (repeated)
+  sizeIds: string, Select only ads with these size IDs. (repeated)
+  archived: boolean, Select only archived ads.
+  creativeOptimizationConfigurationIds: string, Select only ads with these creative optimization configuration IDs. (repeated)
+  sslCompliant: boolean, Select only ads that are SSL-compliant.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  type: string, Select only ads with these types. (repeated)
+    Allowed values
+      AD_SERVING_CLICK_TRACKER - 
+      AD_SERVING_DEFAULT_AD - 
+      AD_SERVING_STANDARD_AD - 
+      AD_SERVING_TRACKING - 
+  sslRequired: boolean, Select only ads that require SSL.
+  creativeIds: string, Select only ads with these creative IDs assigned. (repeated)
+  remarketingListIds: string, Select only ads whose list targeting expression use these remarketing list IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  creativeType: string, Select only ads with the specified creativeType.
+    Allowed values
+      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 - 
+  placementIds: string, Select only ads with these placement IDs assigned. (repeated)
+  active: boolean, Select only active ads.
+  compatibility: string, 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.
+    Allowed values
+      APP - 
+      APP_INTERSTITIAL - 
+      DISPLAY - 
+      DISPLAY_INTERSTITIAL - 
+      IN_STREAM_VIDEO - 
+  advertiserId: string, Select only ads with this advertiser ID.
+  searchString: string, 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".
+  audienceSegmentIds: string, Select only ads with these audience segment IDs. (repeated)
+  ids: string, Select only ads with these IDs. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  dynamicClickTracker: boolean, 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.
+
+Returns:
+  An object of the form:
+
+    { # Ad List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#adsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#adsListResponse".
+    "ads": [ # Ad collection.
+      { # Contains properties of a DCM ad.
+          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+          },
+          "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+          "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+          "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+            "countries": [ # 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.
+              { # Contains information about a country that can be targeted by ads.
+                "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+                "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+                "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+                "countryCode": "A String", # Country code.
+                "name": "A String", # Name of this country.
+              },
+            ],
+            "excludeCountries": True or False, # 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.
+            "postalCodes": [ # 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.
+              { # Contains information about a postal code that can be targeted by ads.
+                "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+                "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+                "code": "A String", # Postal code. This is equivalent to the id field.
+                "id": "A String", # ID of this postal code.
+                "countryCode": "A String", # Country code of the country to which this postal code belongs.
+              },
+            ],
+            "regions": [ # 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.
+              { # Contains information about a region that can be targeted by ads.
+                "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+                "countryDartId": "A String", # DART ID of the country to which this region belongs.
+                "name": "A String", # Name of this region.
+                "countryCode": "A String", # Country code of the country to which this region belongs.
+                "regionCode": "A String", # Region code.
+                "dartId": "A String", # DART ID of this region.
+              },
+            ],
+            "cities": [ # 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.
+              { # Contains information about a city that can be targeted by ads.
+                "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+                "countryDartId": "A String", # DART ID of the country to which this city belongs.
+                "name": "A String", # Name of this city.
+                "countryCode": "A String", # Country code of the country to which this city belongs.
+                "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+                "regionCode": "A String", # Region code of the region to which this city belongs.
+                "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+                "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+                "regionDartId": "A String", # DART ID of the region to which this city belongs.
+              },
+            ],
+            "metros": [ # 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.
+              { # Contains information about a metro region that can be targeted by ads.
+                "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+                "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+                "name": "A String", # Name of this metro region.
+                "countryCode": "A String", # Country code of the country to which this metro region belongs.
+                "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+                "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+                "dartId": "A String", # DART ID of this metro region.
+              },
+            ],
+          },
+          "creativeGroupAssignments": [ # 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.
+            { # Creative Group Assignment.
+              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+              "creativeGroupId": "A String", # ID of the creative group to be assigned.
+            },
+          ],
+          "deliverySchedule": { # Delivery Schedule. # 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.
+            "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+            "hardCutoff": True or False, # 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.
+            "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+              "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+              "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+            },
+            "impressionRatio": "A String", # 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.
+          },
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "eventTagOverrides": [ # Event tag overrides for this ad.
+            { # Event tag override information.
+              "enabled": True or False, # Whether this override is enabled.
+              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+            },
+          ],
+          "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+          "archived": True or False, # Whether this ad is archived.
+          "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+            "platformTypes": [ # 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.
+              { # Contains information about a platform type that can be targeted by ads.
+                "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+                "id": "A String", # ID of this platform type.
+                "name": "A String", # Name of this platform type.
+              },
+            ],
+            "operatingSystemVersions": [ # 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.
+              { # Contains information about a particular version of an operating system that can be targeted by ads.
+                "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+                "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+                "name": "A String", # Name of this operating system version.
+                "id": "A String", # ID of this operating system version.
+                "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+                  "mobile": True or False, # Whether this operating system is for mobile.
+                  "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+                  "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+                  "name": "A String", # Name of this operating system.
+                  "desktop": True or False, # Whether this operating system is for desktop.
+                },
+                "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+              },
+            ],
+            "browsers": [ # 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.
+              { # Contains information about a browser that can be targeted by ads.
+                "majorVersion": "A String", # 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.
+                "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+                "name": "A String", # Name of this browser.
+                "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+                "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+                "minorVersion": "A String", # 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.
+              },
+            ],
+            "operatingSystems": [ # 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.
+              { # Contains information about an operating system that can be targeted by ads.
+                "mobile": True or False, # Whether this operating system is for mobile.
+                "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+                "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+                "name": "A String", # Name of this operating system.
+                "desktop": True or False, # Whether this operating system is for desktop.
+              },
+            ],
+            "mobileCarriers": [ # 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.
+              { # Contains information about a mobile carrier that can be targeted by ads.
+                "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+                "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+                "id": "A String", # ID of this mobile carrier.
+                "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+                "name": "A String", # Name of this mobile carrier.
+              },
+            ],
+            "connectionTypes": [ # 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.
+              { # 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.
+                "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+                "id": "A String", # ID of this connection type.
+                "name": "A String", # Name of this connection type.
+              },
+            ],
+          },
+          "creativeRotation": { # Creative Rotation. # 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.
+            "creativeAssignments": [ # Creative assignments in this creative rotation.
+              { # Creative Assignment.
+                "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+                "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+                "applyEventTags": True or False, # 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.
+                "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+                    # Applicable when the creative type is any of the following:
+                    # - RICH_MEDIA_INPAGE
+                    # - RICH_MEDIA_INPAGE_FLOATING
+                    # - RICH_MEDIA_IM_EXPAND
+                    # - RICH_MEDIA_EXPANDING
+                    # - RICH_MEDIA_INTERSTITIAL_FLOAT
+                    # - RICH_MEDIA_MOBILE_IN_APP
+                    # - RICH_MEDIA_MULTI_FLOATING
+                    # - RICH_MEDIA_PEEL_DOWN
+                    # - ADVANCED_BANNER
+                    # - VPAID_LINEAR
+                    # - VPAID_NON_LINEAR
+                  { # Rich Media Exit Override.
+                    "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+                    "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+                    "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+                  },
+                ],
+                "sslCompliant": True or False, # 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.
+                "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+                  { # Creative Group Assignment.
+                    "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+                    "creativeGroupId": "A String", # ID of the creative group to be assigned.
+                  },
+                ],
+                "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+                  { # Companion Click-through override.
+                    "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                    },
+                    "creativeId": "A String", # ID of the creative for this companion click-through override.
+                  },
+                ],
+                "startTime": "A String", # Date and time that the assigned creative should start serving.
+                "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                },
+                "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+                "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+                "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+                "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+              },
+            ],
+            "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+            "creativeOptimizationConfigurationId": "A String", # 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.
+            "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+          },
+          "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+          },
+          "comments": "A String", # Comments for this ad.
+          "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+            "expression": "A String", # Expression describing which lists are being targeted by the ad.
+          },
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "type": "A String", # 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).
+          "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+          "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+          "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+            "expression": "A String", # Keyword expression being targeted by the ad.
+          },
+          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+          },
+          "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "startTime": "A String", # 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.
+          "active": True or False, # Whether this ad is active.
+          "compatibility": "A String", # 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.
+          "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+          "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+          "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+            "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+            "hoursOfDay": [ # 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.
+              42,
+            ],
+            "daysOfWeek": [ # Days of the week when the ad will serve.
+                #
+                # Acceptable values are:
+                # - "SUNDAY"
+                # - "MONDAY"
+                # - "TUESDAY"
+                # - "WEDNESDAY"
+                # - "THURSDAY"
+                # - "FRIDAY"
+                # - "SATURDAY"
+              "A String",
+            ],
+          },
+          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+          "placementAssignments": [ # Placement assignments for this ad.
+            { # Placement Assignment.
+              "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+              "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+              "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+              "sslRequired": True or False, # 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.
+            },
+          ],
+          "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+          "dynamicClickTracker": True or False, # 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.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing ad. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Ad ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM ad.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+      "countries": [ # 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.
+        { # Contains information about a country that can be targeted by ads.
+          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+          "countryCode": "A String", # Country code.
+          "name": "A String", # Name of this country.
+        },
+      ],
+      "excludeCountries": True or False, # 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.
+      "postalCodes": [ # 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.
+        { # Contains information about a postal code that can be targeted by ads.
+          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+          "code": "A String", # Postal code. This is equivalent to the id field.
+          "id": "A String", # ID of this postal code.
+          "countryCode": "A String", # Country code of the country to which this postal code belongs.
+        },
+      ],
+      "regions": [ # 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.
+        { # Contains information about a region that can be targeted by ads.
+          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+          "countryDartId": "A String", # DART ID of the country to which this region belongs.
+          "name": "A String", # Name of this region.
+          "countryCode": "A String", # Country code of the country to which this region belongs.
+          "regionCode": "A String", # Region code.
+          "dartId": "A String", # DART ID of this region.
+        },
+      ],
+      "cities": [ # 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.
+        { # Contains information about a city that can be targeted by ads.
+          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+          "countryDartId": "A String", # DART ID of the country to which this city belongs.
+          "name": "A String", # Name of this city.
+          "countryCode": "A String", # Country code of the country to which this city belongs.
+          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+          "regionCode": "A String", # Region code of the region to which this city belongs.
+          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+          "regionDartId": "A String", # DART ID of the region to which this city belongs.
+        },
+      ],
+      "metros": [ # 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.
+        { # Contains information about a metro region that can be targeted by ads.
+          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+          "name": "A String", # Name of this metro region.
+          "countryCode": "A String", # Country code of the country to which this metro region belongs.
+          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+          "dartId": "A String", # DART ID of this metro region.
+        },
+      ],
+    },
+    "creativeGroupAssignments": [ # 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.
+      { # Creative Group Assignment.
+        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+        "creativeGroupId": "A String", # ID of the creative group to be assigned.
+      },
+    ],
+    "deliverySchedule": { # Delivery Schedule. # 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.
+      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+      "hardCutoff": True or False, # 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.
+      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+      },
+      "impressionRatio": "A String", # 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.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Event tag overrides for this ad.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this ad is archived.
+    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "platformTypes": [ # 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.
+        { # Contains information about a platform type that can be targeted by ads.
+          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+          "id": "A String", # ID of this platform type.
+          "name": "A String", # Name of this platform type.
+        },
+      ],
+      "operatingSystemVersions": [ # 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.
+        { # Contains information about a particular version of an operating system that can be targeted by ads.
+          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+          "name": "A String", # Name of this operating system version.
+          "id": "A String", # ID of this operating system version.
+          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+        },
+      ],
+      "browsers": [ # 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.
+        { # Contains information about a browser that can be targeted by ads.
+          "majorVersion": "A String", # 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.
+          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+          "name": "A String", # Name of this browser.
+          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+          "minorVersion": "A String", # 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.
+        },
+      ],
+      "operatingSystems": [ # 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.
+        { # Contains information about an operating system that can be targeted by ads.
+          "mobile": True or False, # Whether this operating system is for mobile.
+          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+          "name": "A String", # Name of this operating system.
+          "desktop": True or False, # Whether this operating system is for desktop.
+        },
+      ],
+      "mobileCarriers": [ # 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.
+        { # Contains information about a mobile carrier that can be targeted by ads.
+          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+          "id": "A String", # ID of this mobile carrier.
+          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+          "name": "A String", # Name of this mobile carrier.
+        },
+      ],
+      "connectionTypes": [ # 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.
+        { # 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.
+          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+          "id": "A String", # ID of this connection type.
+          "name": "A String", # Name of this connection type.
+        },
+      ],
+    },
+    "creativeRotation": { # Creative Rotation. # 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.
+      "creativeAssignments": [ # Creative assignments in this creative rotation.
+        { # Creative Assignment.
+          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+          "applyEventTags": True or False, # 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.
+          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+              # Applicable when the creative type is any of the following:
+              # - RICH_MEDIA_INPAGE
+              # - RICH_MEDIA_INPAGE_FLOATING
+              # - RICH_MEDIA_IM_EXPAND
+              # - RICH_MEDIA_EXPANDING
+              # - RICH_MEDIA_INTERSTITIAL_FLOAT
+              # - RICH_MEDIA_MOBILE_IN_APP
+              # - RICH_MEDIA_MULTI_FLOATING
+              # - RICH_MEDIA_PEEL_DOWN
+              # - ADVANCED_BANNER
+              # - VPAID_LINEAR
+              # - VPAID_NON_LINEAR
+            { # Rich Media Exit Override.
+              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+            },
+          ],
+          "sslCompliant": True or False, # 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.
+          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+            { # Creative Group Assignment.
+              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+              "creativeGroupId": "A String", # ID of the creative group to be assigned.
+            },
+          ],
+          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+            { # Companion Click-through override.
+              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+              },
+              "creativeId": "A String", # ID of the creative for this companion click-through override.
+            },
+          ],
+          "startTime": "A String", # Date and time that the assigned creative should start serving.
+          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+          },
+          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+      "creativeOptimizationConfigurationId": "A String", # 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.
+      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+    },
+    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+    },
+    "comments": "A String", # Comments for this ad.
+    "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+      "expression": "A String", # Expression describing which lists are being targeted by the ad.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # 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).
+    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "expression": "A String", # Keyword expression being targeted by the ad.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "startTime": "A String", # 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.
+    "active": True or False, # Whether this ad is active.
+    "compatibility": "A String", # 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.
+    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+      "hoursOfDay": [ # 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.
+        42,
+      ],
+      "daysOfWeek": [ # Days of the week when the ad will serve.
+          #
+          # Acceptable values are:
+          # - "SUNDAY"
+          # - "MONDAY"
+          # - "TUESDAY"
+          # - "WEDNESDAY"
+          # - "THURSDAY"
+          # - "FRIDAY"
+          # - "SATURDAY"
+        "A String",
+      ],
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "placementAssignments": [ # Placement assignments for this ad.
+      { # Placement Assignment.
+        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+        "sslRequired": True or False, # 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.
+      },
+    ],
+    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+    "dynamicClickTracker": True or False, # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM ad.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+        "countries": [ # 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.
+          { # Contains information about a country that can be targeted by ads.
+            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+            "countryCode": "A String", # Country code.
+            "name": "A String", # Name of this country.
+          },
+        ],
+        "excludeCountries": True or False, # 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.
+        "postalCodes": [ # 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.
+          { # Contains information about a postal code that can be targeted by ads.
+            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+            "code": "A String", # Postal code. This is equivalent to the id field.
+            "id": "A String", # ID of this postal code.
+            "countryCode": "A String", # Country code of the country to which this postal code belongs.
+          },
+        ],
+        "regions": [ # 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.
+          { # Contains information about a region that can be targeted by ads.
+            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+            "countryDartId": "A String", # DART ID of the country to which this region belongs.
+            "name": "A String", # Name of this region.
+            "countryCode": "A String", # Country code of the country to which this region belongs.
+            "regionCode": "A String", # Region code.
+            "dartId": "A String", # DART ID of this region.
+          },
+        ],
+        "cities": [ # 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.
+          { # Contains information about a city that can be targeted by ads.
+            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+            "countryDartId": "A String", # DART ID of the country to which this city belongs.
+            "name": "A String", # Name of this city.
+            "countryCode": "A String", # Country code of the country to which this city belongs.
+            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+            "regionCode": "A String", # Region code of the region to which this city belongs.
+            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+            "regionDartId": "A String", # DART ID of the region to which this city belongs.
+          },
+        ],
+        "metros": [ # 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.
+          { # Contains information about a metro region that can be targeted by ads.
+            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+            "name": "A String", # Name of this metro region.
+            "countryCode": "A String", # Country code of the country to which this metro region belongs.
+            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+            "dartId": "A String", # DART ID of this metro region.
+          },
+        ],
+      },
+      "creativeGroupAssignments": [ # 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.
+        { # Creative Group Assignment.
+          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+          "creativeGroupId": "A String", # ID of the creative group to be assigned.
+        },
+      ],
+      "deliverySchedule": { # Delivery Schedule. # 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.
+        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+        "hardCutoff": True or False, # 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.
+        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+        },
+        "impressionRatio": "A String", # 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.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Event tag overrides for this ad.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this ad is archived.
+      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "platformTypes": [ # 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.
+          { # Contains information about a platform type that can be targeted by ads.
+            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+            "id": "A String", # ID of this platform type.
+            "name": "A String", # Name of this platform type.
+          },
+        ],
+        "operatingSystemVersions": [ # 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.
+          { # Contains information about a particular version of an operating system that can be targeted by ads.
+            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+            "name": "A String", # Name of this operating system version.
+            "id": "A String", # ID of this operating system version.
+            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+              "mobile": True or False, # Whether this operating system is for mobile.
+              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+              "name": "A String", # Name of this operating system.
+              "desktop": True or False, # Whether this operating system is for desktop.
+            },
+            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+          },
+        ],
+        "browsers": [ # 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.
+          { # Contains information about a browser that can be targeted by ads.
+            "majorVersion": "A String", # 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.
+            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+            "name": "A String", # Name of this browser.
+            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+            "minorVersion": "A String", # 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.
+          },
+        ],
+        "operatingSystems": [ # 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.
+          { # Contains information about an operating system that can be targeted by ads.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+        ],
+        "mobileCarriers": [ # 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.
+          { # Contains information about a mobile carrier that can be targeted by ads.
+            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+            "id": "A String", # ID of this mobile carrier.
+            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+            "name": "A String", # Name of this mobile carrier.
+          },
+        ],
+        "connectionTypes": [ # 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.
+          { # 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.
+            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+            "id": "A String", # ID of this connection type.
+            "name": "A String", # Name of this connection type.
+          },
+        ],
+      },
+      "creativeRotation": { # Creative Rotation. # 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.
+        "creativeAssignments": [ # Creative assignments in this creative rotation.
+          { # Creative Assignment.
+            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+            "applyEventTags": True or False, # 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.
+            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+                # Applicable when the creative type is any of the following:
+                # - RICH_MEDIA_INPAGE
+                # - RICH_MEDIA_INPAGE_FLOATING
+                # - RICH_MEDIA_IM_EXPAND
+                # - RICH_MEDIA_EXPANDING
+                # - RICH_MEDIA_INTERSTITIAL_FLOAT
+                # - RICH_MEDIA_MOBILE_IN_APP
+                # - RICH_MEDIA_MULTI_FLOATING
+                # - RICH_MEDIA_PEEL_DOWN
+                # - ADVANCED_BANNER
+                # - VPAID_LINEAR
+                # - VPAID_NON_LINEAR
+              { # Rich Media Exit Override.
+                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+              },
+            ],
+            "sslCompliant": True or False, # 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.
+            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+              { # Creative Group Assignment.
+                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+                "creativeGroupId": "A String", # ID of the creative group to be assigned.
+              },
+            ],
+            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+              { # Companion Click-through override.
+                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                },
+                "creativeId": "A String", # ID of the creative for this companion click-through override.
+              },
+            ],
+            "startTime": "A String", # Date and time that the assigned creative should start serving.
+            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+            },
+            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          },
+        ],
+        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+        "creativeOptimizationConfigurationId": "A String", # 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.
+        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+      },
+      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+      },
+      "comments": "A String", # Comments for this ad.
+      "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+        "expression": "A String", # Expression describing which lists are being targeted by the ad.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # 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).
+      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "expression": "A String", # Keyword expression being targeted by the ad.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "startTime": "A String", # 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.
+      "active": True or False, # Whether this ad is active.
+      "compatibility": "A String", # 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.
+      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+        "hoursOfDay": [ # 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.
+          42,
+        ],
+        "daysOfWeek": [ # Days of the week when the ad will serve.
+            #
+            # Acceptable values are:
+            # - "SUNDAY"
+            # - "MONDAY"
+            # - "TUESDAY"
+            # - "WEDNESDAY"
+            # - "THURSDAY"
+            # - "FRIDAY"
+            # - "SATURDAY"
+          "A String",
+        ],
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "placementAssignments": [ # Placement assignments for this ad.
+        { # Placement Assignment.
+          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+          "sslRequired": True or False, # 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.
+        },
+      ],
+      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+      "dynamicClickTracker": True or False, # 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.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing ad.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM ad.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+    "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+    "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+      "countries": [ # 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.
+        { # Contains information about a country that can be targeted by ads.
+          "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+          "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+          "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+          "countryCode": "A String", # Country code.
+          "name": "A String", # Name of this country.
+        },
+      ],
+      "excludeCountries": True or False, # 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.
+      "postalCodes": [ # 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.
+        { # Contains information about a postal code that can be targeted by ads.
+          "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+          "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+          "code": "A String", # Postal code. This is equivalent to the id field.
+          "id": "A String", # ID of this postal code.
+          "countryCode": "A String", # Country code of the country to which this postal code belongs.
+        },
+      ],
+      "regions": [ # 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.
+        { # Contains information about a region that can be targeted by ads.
+          "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+          "countryDartId": "A String", # DART ID of the country to which this region belongs.
+          "name": "A String", # Name of this region.
+          "countryCode": "A String", # Country code of the country to which this region belongs.
+          "regionCode": "A String", # Region code.
+          "dartId": "A String", # DART ID of this region.
+        },
+      ],
+      "cities": [ # 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.
+        { # Contains information about a city that can be targeted by ads.
+          "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+          "countryDartId": "A String", # DART ID of the country to which this city belongs.
+          "name": "A String", # Name of this city.
+          "countryCode": "A String", # Country code of the country to which this city belongs.
+          "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+          "regionCode": "A String", # Region code of the region to which this city belongs.
+          "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+          "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+          "regionDartId": "A String", # DART ID of the region to which this city belongs.
+        },
+      ],
+      "metros": [ # 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.
+        { # Contains information about a metro region that can be targeted by ads.
+          "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+          "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+          "name": "A String", # Name of this metro region.
+          "countryCode": "A String", # Country code of the country to which this metro region belongs.
+          "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+          "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+          "dartId": "A String", # DART ID of this metro region.
+        },
+      ],
+    },
+    "creativeGroupAssignments": [ # 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.
+      { # Creative Group Assignment.
+        "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+        "creativeGroupId": "A String", # ID of the creative group to be assigned.
+      },
+    ],
+    "deliverySchedule": { # Delivery Schedule. # 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.
+      "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+      "hardCutoff": True or False, # 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.
+      "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+        "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+        "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+      },
+      "impressionRatio": "A String", # 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.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Event tag overrides for this ad.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this ad is archived.
+    "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "platformTypes": [ # 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.
+        { # Contains information about a platform type that can be targeted by ads.
+          "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+          "id": "A String", # ID of this platform type.
+          "name": "A String", # Name of this platform type.
+        },
+      ],
+      "operatingSystemVersions": [ # 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.
+        { # Contains information about a particular version of an operating system that can be targeted by ads.
+          "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+          "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+          "name": "A String", # Name of this operating system version.
+          "id": "A String", # ID of this operating system version.
+          "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+          "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+        },
+      ],
+      "browsers": [ # 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.
+        { # Contains information about a browser that can be targeted by ads.
+          "majorVersion": "A String", # 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.
+          "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+          "name": "A String", # Name of this browser.
+          "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+          "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+          "minorVersion": "A String", # 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.
+        },
+      ],
+      "operatingSystems": [ # 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.
+        { # Contains information about an operating system that can be targeted by ads.
+          "mobile": True or False, # Whether this operating system is for mobile.
+          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+          "name": "A String", # Name of this operating system.
+          "desktop": True or False, # Whether this operating system is for desktop.
+        },
+      ],
+      "mobileCarriers": [ # 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.
+        { # Contains information about a mobile carrier that can be targeted by ads.
+          "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+          "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+          "id": "A String", # ID of this mobile carrier.
+          "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+          "name": "A String", # Name of this mobile carrier.
+        },
+      ],
+      "connectionTypes": [ # 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.
+        { # 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.
+          "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+          "id": "A String", # ID of this connection type.
+          "name": "A String", # Name of this connection type.
+        },
+      ],
+    },
+    "creativeRotation": { # Creative Rotation. # 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.
+      "creativeAssignments": [ # Creative assignments in this creative rotation.
+        { # Creative Assignment.
+          "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+          "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+          "applyEventTags": True or False, # 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.
+          "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+              # Applicable when the creative type is any of the following:
+              # - RICH_MEDIA_INPAGE
+              # - RICH_MEDIA_INPAGE_FLOATING
+              # - RICH_MEDIA_IM_EXPAND
+              # - RICH_MEDIA_EXPANDING
+              # - RICH_MEDIA_INTERSTITIAL_FLOAT
+              # - RICH_MEDIA_MOBILE_IN_APP
+              # - RICH_MEDIA_MULTI_FLOATING
+              # - RICH_MEDIA_PEEL_DOWN
+              # - ADVANCED_BANNER
+              # - VPAID_LINEAR
+              # - VPAID_NON_LINEAR
+            { # Rich Media Exit Override.
+              "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+              "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+              "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+            },
+          ],
+          "sslCompliant": True or False, # 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.
+          "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+            { # Creative Group Assignment.
+              "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+              "creativeGroupId": "A String", # ID of the creative group to be assigned.
+            },
+          ],
+          "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+            { # Companion Click-through override.
+              "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                    # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                    # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                    # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+              },
+              "creativeId": "A String", # ID of the creative for this companion click-through override.
+            },
+          ],
+          "startTime": "A String", # Date and time that the assigned creative should start serving.
+          "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+            "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+            "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+            "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+            "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+          },
+          "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+          "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+          "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+          "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+      "creativeOptimizationConfigurationId": "A String", # 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.
+      "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+    },
+    "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+      "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+          # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+          # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+          # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+      "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+      "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+      "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+    },
+    "comments": "A String", # Comments for this ad.
+    "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+      "expression": "A String", # Expression describing which lists are being targeted by the ad.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # 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).
+    "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+    "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "expression": "A String", # Keyword expression being targeted by the ad.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "startTime": "A String", # 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.
+    "active": True or False, # Whether this ad is active.
+    "compatibility": "A String", # 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.
+    "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+    "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+    "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+      "hoursOfDay": [ # 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.
+        42,
+      ],
+      "daysOfWeek": [ # Days of the week when the ad will serve.
+          #
+          # Acceptable values are:
+          # - "SUNDAY"
+          # - "MONDAY"
+          # - "TUESDAY"
+          # - "WEDNESDAY"
+          # - "THURSDAY"
+          # - "FRIDAY"
+          # - "SATURDAY"
+        "A String",
+      ],
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+    "placementAssignments": [ # Placement assignments for this ad.
+      { # Placement Assignment.
+        "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+        "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+        "sslRequired": True or False, # 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.
+      },
+    ],
+    "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+    "dynamicClickTracker": True or False, # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM ad.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # 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.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "campaignId": "A String", # Campaign ID of this ad. This is a required field on insertion.
+      "advertiserId": "A String", # Advertiser ID of this ad. This is a required field on insertion.
+      "geoTargeting": { # Geographical Targeting. # Geographical targeting information for this ad.Applicable when type is AD_SERVING_STANDARD_AD.
+        "countries": [ # 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.
+          { # Contains information about a country that can be targeted by ads.
+            "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+            "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+            "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+            "countryCode": "A String", # Country code.
+            "name": "A String", # Name of this country.
+          },
+        ],
+        "excludeCountries": True or False, # 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.
+        "postalCodes": [ # 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.
+          { # Contains information about a postal code that can be targeted by ads.
+            "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+            "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+            "code": "A String", # Postal code. This is equivalent to the id field.
+            "id": "A String", # ID of this postal code.
+            "countryCode": "A String", # Country code of the country to which this postal code belongs.
+          },
+        ],
+        "regions": [ # 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.
+          { # Contains information about a region that can be targeted by ads.
+            "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+            "countryDartId": "A String", # DART ID of the country to which this region belongs.
+            "name": "A String", # Name of this region.
+            "countryCode": "A String", # Country code of the country to which this region belongs.
+            "regionCode": "A String", # Region code.
+            "dartId": "A String", # DART ID of this region.
+          },
+        ],
+        "cities": [ # 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.
+          { # Contains information about a city that can be targeted by ads.
+            "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+            "countryDartId": "A String", # DART ID of the country to which this city belongs.
+            "name": "A String", # Name of this city.
+            "countryCode": "A String", # Country code of the country to which this city belongs.
+            "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+            "regionCode": "A String", # Region code of the region to which this city belongs.
+            "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+            "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+            "regionDartId": "A String", # DART ID of the region to which this city belongs.
+          },
+        ],
+        "metros": [ # 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.
+          { # Contains information about a metro region that can be targeted by ads.
+            "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+            "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+            "name": "A String", # Name of this metro region.
+            "countryCode": "A String", # Country code of the country to which this metro region belongs.
+            "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+            "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+            "dartId": "A String", # DART ID of this metro region.
+          },
+        ],
+      },
+      "creativeGroupAssignments": [ # 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.
+        { # Creative Group Assignment.
+          "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+          "creativeGroupId": "A String", # ID of the creative group to be assigned.
+        },
+      ],
+      "deliverySchedule": { # Delivery Schedule. # 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.
+        "priority": "A String", # Serving priority of an ad, with respect to other ads. The lower the priority number, the greater the priority with which it is served.
+        "hardCutoff": True or False, # 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.
+        "frequencyCap": { # Frequency Cap. # Limit on the number of times an individual user can be served the ad within a specified period of time.
+          "duration": "A String", # Duration of time, in seconds, for this frequency cap. The maximum duration is 90 days in seconds, or 7,776,000.
+          "impressions": "A String", # Number of times an individual user can be served the ad within the specified duration. The maximum allowed is 15.
+        },
+        "impressionRatio": "A String", # 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.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Event tag overrides for this ad.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "id": "A String", # ID of this ad. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this ad. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this ad is archived.
+      "technologyTargeting": { # Technology Targeting. # Technology platform targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "platformTypes": [ # 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.
+          { # Contains information about a platform type that can be targeted by ads.
+            "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+            "id": "A String", # ID of this platform type.
+            "name": "A String", # Name of this platform type.
+          },
+        ],
+        "operatingSystemVersions": [ # 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.
+          { # Contains information about a particular version of an operating system that can be targeted by ads.
+            "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+            "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+            "name": "A String", # Name of this operating system version.
+            "id": "A String", # ID of this operating system version.
+            "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+              "mobile": True or False, # Whether this operating system is for mobile.
+              "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+              "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+              "name": "A String", # Name of this operating system.
+              "desktop": True or False, # Whether this operating system is for desktop.
+            },
+            "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+          },
+        ],
+        "browsers": [ # 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.
+          { # Contains information about a browser that can be targeted by ads.
+            "majorVersion": "A String", # 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.
+            "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+            "name": "A String", # Name of this browser.
+            "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+            "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+            "minorVersion": "A String", # 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.
+          },
+        ],
+        "operatingSystems": [ # 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.
+          { # Contains information about an operating system that can be targeted by ads.
+            "mobile": True or False, # Whether this operating system is for mobile.
+            "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+            "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+            "name": "A String", # Name of this operating system.
+            "desktop": True or False, # Whether this operating system is for desktop.
+          },
+        ],
+        "mobileCarriers": [ # 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.
+          { # Contains information about a mobile carrier that can be targeted by ads.
+            "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+            "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+            "id": "A String", # ID of this mobile carrier.
+            "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+            "name": "A String", # Name of this mobile carrier.
+          },
+        ],
+        "connectionTypes": [ # 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.
+          { # 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.
+            "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+            "id": "A String", # ID of this connection type.
+            "name": "A String", # Name of this connection type.
+          },
+        ],
+      },
+      "creativeRotation": { # Creative Rotation. # 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.
+        "creativeAssignments": [ # Creative assignments in this creative rotation.
+          { # Creative Assignment.
+            "weight": 42, # Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM.
+            "sequence": 42, # Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL.
+            "applyEventTags": True or False, # 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.
+            "richMediaExitOverrides": [ # Rich media exit overrides for this creative assignment.
+                # Applicable when the creative type is any of the following:
+                # - RICH_MEDIA_INPAGE
+                # - RICH_MEDIA_INPAGE_FLOATING
+                # - RICH_MEDIA_IM_EXPAND
+                # - RICH_MEDIA_EXPANDING
+                # - RICH_MEDIA_INTERSTITIAL_FLOAT
+                # - RICH_MEDIA_MOBILE_IN_APP
+                # - RICH_MEDIA_MULTI_FLOATING
+                # - RICH_MEDIA_PEEL_DOWN
+                # - ADVANCED_BANNER
+                # - VPAID_LINEAR
+                # - VPAID_NON_LINEAR
+              { # Rich Media Exit Override.
+                "customExitUrl": "A String", # Click-through URL to override the default exit URL. Applicable if the useCustomExitUrl field is set to true.
+                "useCustomExitUrl": True or False, # Whether to use the custom exit URL.
+                "exitId": "A String", # ID for the override to refer to a specific exit in the creative.
+              },
+            ],
+            "sslCompliant": True or False, # 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.
+            "creativeGroupAssignments": [ # Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments.
+              { # Creative Group Assignment.
+                "creativeGroupNumber": "A String", # Creative group number of the creative group assignment.
+                "creativeGroupId": "A String", # ID of the creative group to be assigned.
+              },
+            ],
+            "companionCreativeOverrides": [ # Companion creative overrides for this creative assignment. Applicable to video ads.
+              { # Companion Click-through override.
+                "clickThroughUrl": { # Click-through URL # Click-through URL of this companion click-through override.
+                  "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                      # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                      # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                      # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+                  "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+                  "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+                  "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+                },
+                "creativeId": "A String", # ID of the creative for this companion click-through override.
+              },
+            ],
+            "startTime": "A String", # Date and time that the assigned creative should start serving.
+            "clickThroughUrl": { # Click-through URL # Click-through URL of the creative assignment.
+              "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+                  # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+                  # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+                  # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+              "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+              "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+              "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+            },
+            "active": True or False, # Whether this creative assignment is active. When true, the creative will be included in the ad's rotation.
+            "creativeId": "A String", # ID of the creative to be assigned. This is a required field.
+            "endTime": "A String", # Date and time that the assigned creative should stop serving. Must be later than the start time.
+            "creativeIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the creative. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          },
+        ],
+        "weightCalculationStrategy": "A String", # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM.
+        "creativeOptimizationConfigurationId": "A String", # 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.
+        "type": "A String", # Type of creative rotation. Can be used to specify whether to use sequential or random rotation.
+      },
+      "clickThroughUrl": { # Click-through URL # Click-through URL for this ad. This is a required field on insertion. Applicable when type is AD_SERVING_CLICK_TRACKER.
+        "computedClickThroughUrl": "A String", # Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows:
+            # - If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.
+            # - If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.
+            # - If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.
+        "customClickThroughUrl": "A String", # Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.
+        "landingPageId": "A String", # ID of the landing page for the click-through URL. Applicable if the defaultLandingPage field is set to false.
+        "defaultLandingPage": True or False, # Whether the campaign default landing page is used.
+      },
+      "comments": "A String", # Comments for this ad.
+      "remarketingListExpression": { # Remarketing List Targeting Expression. # Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad.
+        "expression": "A String", # Expression describing which lists are being targeted by the ad.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this ad. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # 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).
+      "sslRequired": True or False, # Whether this ad requires ssl. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "audienceSegmentId": "A String", # Audience segment ID that is being targeted for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+      "keyValueTargetingExpression": { # Key Value Targeting Expression. # Key-value targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "expression": "A String", # Keyword expression being targeted by the ad.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Default click-through event tag properties for this ad.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this ad.This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "startTime": "A String", # 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.
+      "active": True or False, # Whether this ad is active.
+      "compatibility": "A String", # 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.
+      "kind": "dfareporting#ad", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ad".
+      "subaccountId": "A String", # Subaccount ID of this ad. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this ad. This is a required field and must be less than 256 characters long.
+      "dayPartTargeting": { # Day Part Targeting. # Time and day targeting information for this ad. Applicable when type is AD_SERVING_STANDARD_AD.
+        "userLocalTime": True or False, # Whether or not to use the user's local time. If false, the America/New York time zone applies.
+        "hoursOfDay": [ # 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.
+          42,
+        ],
+        "daysOfWeek": [ # Days of the week when the ad will serve.
+            #
+            # Acceptable values are:
+            # - "SUNDAY"
+            # - "MONDAY"
+            # - "TUESDAY"
+            # - "WEDNESDAY"
+            # - "THURSDAY"
+            # - "FRIDAY"
+            # - "SATURDAY"
+          "A String",
+        ],
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this ad. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "sslCompliant": True or False, # Whether this ad is ssl compliant. This is a read-only field that is auto-generated when the ad is inserted or updated.
+      "placementAssignments": [ # Placement assignments for this ad.
+        { # Placement Assignment.
+          "active": True or False, # Whether this placement assignment is active. When true, the placement will be included in the ad's rotation.
+          "placementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "placementId": "A String", # ID of the placement to be assigned. This is a required field.
+          "sslRequired": True or False, # 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.
+        },
+      ],
+      "endTime": "A String", # Date and time that this ad should stop serving. Must be later than the start time. This is a required field on insertion.
+      "dynamicClickTracker": True or False, # 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.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.advertiserGroups.html b/docs/dyn/dfareporting_v2_4.advertiserGroups.html new file mode 100644 index 00000000000..2be380464c9 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.advertiserGroups.html @@ -0,0 +1,263 @@ + + + +

DCM/DFA Reporting And Trafficking API . advertiserGroups

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing advertiser group.

+

+ get(profileId, id)

+

Gets one advertiser group by ID.

+

+ insert(profileId, body)

+

Inserts a new advertiser group.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of advertiser groups, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing advertiser group. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing advertiser group.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing advertiser group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Advertiser group ID. (required)
+
+
+ +
+ get(profileId, id) +
Gets one advertiser group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Advertiser group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Groups advertisers together so that reports can be generated for the entire group at once.
+      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new advertiser group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Groups advertisers together so that reports can be generated for the entire group at once.
+      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of advertiser groups, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only advertiser groups with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Advertiser Group List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#advertiserGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
+    "advertiserGroups": [ # Advertiser group collection.
+      { # Groups advertisers together so that reports can be generated for the entire group at once.
+          "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+          "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+          "name": "A String", # 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.
+          "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing advertiser group. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Advertiser group ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Groups advertisers together so that reports can be generated for the entire group at once.
+      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing advertiser group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Groups advertisers together so that reports can be generated for the entire group at once.
+    "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+    "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Groups advertisers together so that reports can be generated for the entire group at once.
+      "kind": "dfareporting#advertiserGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
+      "id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.advertisers.html b/docs/dyn/dfareporting_v2_4.advertisers.html new file mode 100644 index 00000000000..31df699bbd5 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.advertisers.html @@ -0,0 +1,475 @@ + + + +

DCM/DFA Reporting And Trafficking API . advertisers

+

Instance Methods

+

+ get(profileId, id)

+

Gets one advertiser by ID.

+

+ insert(profileId, body)

+

Inserts a new advertiser.

+

+ list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None)

+

Retrieves a list of advertisers, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing advertiser. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing advertiser.

+

Method Details

+
+ get(profileId, id) +
Gets one advertiser by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Advertiser ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM advertiser.
+      "status": "A String", # Status of this advertiser.
+      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+      "originalFloodlightConfigurationId": "A String", # 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.
+      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+      "floodlightConfigurationId": "A String", # 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:
+          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+      "suspended": True or False, # Suspension status of this advertiser.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserGroupId": "A String", # 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.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new advertiser.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM advertiser.
+    "status": "A String", # Status of this advertiser.
+    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+    "originalFloodlightConfigurationId": "A String", # 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.
+    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+    "floodlightConfigurationId": "A String", # 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:
+        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+    "suspended": True or False, # Suspension status of this advertiser.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserGroupId": "A String", # 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.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM advertiser.
+      "status": "A String", # Status of this advertiser.
+      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+      "originalFloodlightConfigurationId": "A String", # 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.
+      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+      "floodlightConfigurationId": "A String", # 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:
+          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+      "suspended": True or False, # Suspension status of this advertiser.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserGroupId": "A String", # 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.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, includeAdvertisersWithoutGroupsOnly=None, onlyParent=None, pageToken=None, sortOrder=None, status=None, maxResults=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, floodlightConfigurationIds=None, sortField=None) +
Retrieves a list of advertisers, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  includeAdvertisersWithoutGroupsOnly: boolean, Select only advertisers which do not belong to any advertiser group.
+  onlyParent: boolean, Select only advertisers which use another advertiser's floodlight configuration.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  status: string, Select only advertisers with the specified status.
+    Allowed values
+      APPROVED - 
+      ON_HOLD - 
+  maxResults: integer, Maximum number of results to return.
+  advertiserGroupIds: string, Select only advertisers with these advertiser group IDs. (repeated)
+  searchString: string, 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".
+  subaccountId: string, Select only advertisers with these subaccount IDs.
+  ids: string, Select only advertisers with these IDs. (repeated)
+  floodlightConfigurationIds: string, Select only advertisers with these floodlight configuration IDs. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+
+Returns:
+  An object of the form:
+
+    { # Advertiser List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "advertisers": [ # Advertiser collection.
+      { # Contains properties of a DCM advertiser.
+          "status": "A String", # Status of this advertiser.
+          "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+          "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+          "name": "A String", # 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.
+          "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+          "originalFloodlightConfigurationId": "A String", # 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.
+          "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+          "floodlightConfigurationId": "A String", # 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:
+              # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+              # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+          "suspended": True or False, # Suspension status of this advertiser.
+          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "advertiserGroupId": "A String", # 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.
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+          "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#advertisersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertisersListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing advertiser. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Advertiser ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM advertiser.
+    "status": "A String", # Status of this advertiser.
+    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+    "originalFloodlightConfigurationId": "A String", # 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.
+    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+    "floodlightConfigurationId": "A String", # 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:
+        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+    "suspended": True or False, # Suspension status of this advertiser.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserGroupId": "A String", # 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.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM advertiser.
+      "status": "A String", # Status of this advertiser.
+      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+      "originalFloodlightConfigurationId": "A String", # 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.
+      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+      "floodlightConfigurationId": "A String", # 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:
+          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+      "suspended": True or False, # Suspension status of this advertiser.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserGroupId": "A String", # 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.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing advertiser.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM advertiser.
+    "status": "A String", # Status of this advertiser.
+    "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+    "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+    "originalFloodlightConfigurationId": "A String", # 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.
+    "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+    "floodlightConfigurationId": "A String", # 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:
+        # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+        # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+    "suspended": True or False, # Suspension status of this advertiser.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserGroupId": "A String", # 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.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+    "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM advertiser.
+      "status": "A String", # Status of this advertiser.
+      "kind": "dfareporting#advertiser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
+      "subaccountId": "A String", # Subaccount ID of this advertiser.This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
+      "originalFloodlightConfigurationId": "A String", # 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.
+      "clickThroughUrlSuffix": "A String", # Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
+      "floodlightConfigurationId": "A String", # 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:
+          # - This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
+          # - This advertiser's original floodlight configuration is not already shared with another advertiser.
+      "suspended": True or False, # Suspension status of this advertiser.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserGroupId": "A String", # 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.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "defaultEmail": "A String", # Default email address used in sender field for tag emails.
+      "id": "A String", # ID of this advertiser. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this advertiser.This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.browsers.html b/docs/dyn/dfareporting_v2_4.browsers.html new file mode 100644 index 00000000000..ab147eec82f --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.browsers.html @@ -0,0 +1,106 @@ + + + +

DCM/DFA Reporting And Trafficking API . browsers

+

Instance Methods

+

+ list(profileId)

+

Retrieves a list of browsers.

+

Method Details

+
+ list(profileId) +
Retrieves a list of browsers.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Browser List Response
+    "kind": "dfareporting#browsersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browsersListResponse".
+    "browsers": [ # Browser collection.
+      { # Contains information about a browser that can be targeted by ads.
+        "majorVersion": "A String", # 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.
+        "kind": "dfareporting#browser", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#browser".
+        "name": "A String", # Name of this browser.
+        "browserVersionId": "A String", # ID referring to this grouping of browser and version numbers. This is the ID used for targeting.
+        "dartId": "A String", # DART ID of this browser. This is the ID used when generating reports.
+        "minorVersion": "A String", # 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.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.campaignCreativeAssociations.html b/docs/dyn/dfareporting_v2_4.campaignCreativeAssociations.html new file mode 100644 index 00000000000..3e92444a86b --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.campaignCreativeAssociations.html @@ -0,0 +1,155 @@ + + + +

DCM/DFA Reporting And Trafficking API . campaignCreativeAssociations

+

Instance Methods

+

+ insert(profileId, campaignId, body)

+

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.

+

+ list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None)

+

Retrieves the list of creative IDs associated with the specified campaign.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ insert(profileId, campaignId, body) +
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.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Campaign ID in this association. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Identifies a creative which has been associated with a given campaign.
+    "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+    "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Identifies a creative which has been associated with a given campaign.
+      "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+      "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+    }
+
+ +
+ list(profileId, campaignId, maxResults=None, pageToken=None, sortOrder=None) +
Retrieves the list of creative IDs associated with the specified campaign.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Campaign ID in this association. (required)
+  maxResults: integer, Maximum number of results to return.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Campaign Creative Association List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "campaignCreativeAssociations": [ # Campaign creative association collection
+      { # Identifies a creative which has been associated with a given campaign.
+          "creativeId": "A String", # ID of the creative associated with the campaign. This is a required field.
+          "kind": "dfareporting#campaignCreativeAssociation", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociation".
+        },
+    ],
+    "kind": "dfareporting#campaignCreativeAssociationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignCreativeAssociationsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.campaigns.html b/docs/dyn/dfareporting_v2_4.campaigns.html new file mode 100644 index 00000000000..795b29c64ef --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.campaigns.html @@ -0,0 +1,1139 @@ + + + +

DCM/DFA Reporting And Trafficking API . campaigns

+

Instance Methods

+

+ get(profileId, id)

+

Gets one campaign by ID.

+

+ insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)

+

Inserts a new campaign.

+

+ list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)

+

Retrieves a list of campaigns, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing campaign. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing campaign.

+

Method Details

+
+ get(profileId, id) +
Gets one campaign by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Campaign ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM campaign.
+      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+      "traffickerEmails": [ # Campaign trafficker contact emails.
+        "A String",
+      ],
+      "archived": True or False, # Whether this campaign has been archived.
+      "externalId": "A String", # External ID for this campaign.
+      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+        "A String",
+      ],
+      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+        { # Creative optimization settings.
+          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+            { # Creative optimization activity.
+              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+              "weight": 42, # 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.
+            },
+          ],
+          "optimizationModel": "A String", # Optimization model for this configuration.
+          "id": "A String", # 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.
+          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+        },
+      ],
+      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+        { # Audience Segment Group.
+          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+            { # Audience Segment.
+              "allocation": 42, # 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.
+              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+            },
+          ],
+          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+        },
+      ],
+    }
+
+ +
+ insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body) +
Inserts a new campaign.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
+  defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM campaign.
+    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+    "startDate": "A String", # 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.
+    "endDate": "A String", # 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.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+        { # Creative optimization activity.
+          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "weight": 42, # 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.
+        },
+      ],
+      "optimizationModel": "A String", # Optimization model for this configuration.
+      "id": "A String", # 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.
+      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+    },
+    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+    "traffickerEmails": [ # Campaign trafficker contact emails.
+      "A String",
+    ],
+    "archived": True or False, # Whether this campaign has been archived.
+    "externalId": "A String", # External ID for this campaign.
+    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+      "A String",
+    ],
+    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+      { # Creative optimization settings.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+    ],
+    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+      { # Audience Segment Group.
+        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+          { # Audience Segment.
+            "allocation": 42, # 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.
+            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+          },
+        ],
+        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM campaign.
+      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+      "traffickerEmails": [ # Campaign trafficker contact emails.
+        "A String",
+      ],
+      "archived": True or False, # Whether this campaign has been archived.
+      "externalId": "A String", # External ID for this campaign.
+      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+        "A String",
+      ],
+      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+        { # Creative optimization settings.
+          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+            { # Creative optimization activity.
+              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+              "weight": 42, # 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.
+            },
+          ],
+          "optimizationModel": "A String", # Optimization model for this configuration.
+          "id": "A String", # 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.
+          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+        },
+      ],
+      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+        { # Audience Segment Group.
+          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+            { # Audience Segment.
+              "allocation": 42, # 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.
+              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+            },
+          ],
+          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+        },
+      ],
+    }
+
+ +
+ list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None) +
Retrieves a list of campaigns, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
+  archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
+  advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  maxResults: integer, Maximum number of results to return.
+  excludedIds: string, Exclude campaigns with these IDs. (repeated)
+  advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
+  searchString: string, 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".
+  subaccountId: string, Select only campaigns that belong to this subaccount.
+  ids: string, Select only campaigns with these IDs. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.
+
+Returns:
+  An object of the form:
+
+    { # Campaign List Response
+    "campaigns": [ # Campaign collection.
+      { # Contains properties of a DCM campaign.
+          "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+            "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+            "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+          },
+          "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+            { # Event tag override information.
+              "enabled": True or False, # Whether this override is enabled.
+              "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+            },
+          ],
+          "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+            "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+              { # Creative optimization activity.
+                "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+                "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+                "weight": 42, # 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.
+              },
+            ],
+            "optimizationModel": "A String", # Optimization model for this configuration.
+            "id": "A String", # 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.
+            "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+          },
+          "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+          "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+          "traffickerEmails": [ # Campaign trafficker contact emails.
+            "A String",
+          ],
+          "archived": True or False, # Whether this campaign has been archived.
+          "externalId": "A String", # External ID for this campaign.
+          "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+          "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+          "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+            "A String",
+          ],
+          "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+            { # Creative optimization settings.
+              "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+                { # Creative optimization activity.
+                  "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+                  "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                    "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                    "value": "A String", # The value of the dimension.
+                    "dimensionName": "A String", # The name of the dimension.
+                    "etag": "A String", # The eTag of this response for caching purposes.
+                    "matchType": "A String", # 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.
+                    "id": "A String", # The ID associated with the value if available.
+                  },
+                  "weight": 42, # 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.
+                },
+              ],
+              "optimizationModel": "A String", # Optimization model for this configuration.
+              "id": "A String", # 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.
+              "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+            },
+          ],
+          "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+            "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+            "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+          },
+          "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+          "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+          "name": "A String", # 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.
+          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+            "clickDuration": 42, # 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.
+            "postImpressionActivitiesDuration": 42, # 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.
+          },
+          "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+            { # Audience Segment Group.
+              "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+                { # Audience Segment.
+                  "allocation": 42, # 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.
+                  "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+                  "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+                },
+              ],
+              "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+            },
+          ],
+        },
+    ],
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing campaign. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Campaign ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM campaign.
+    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+    "startDate": "A String", # 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.
+    "endDate": "A String", # 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.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+        { # Creative optimization activity.
+          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "weight": 42, # 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.
+        },
+      ],
+      "optimizationModel": "A String", # Optimization model for this configuration.
+      "id": "A String", # 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.
+      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+    },
+    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+    "traffickerEmails": [ # Campaign trafficker contact emails.
+      "A String",
+    ],
+    "archived": True or False, # Whether this campaign has been archived.
+    "externalId": "A String", # External ID for this campaign.
+    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+      "A String",
+    ],
+    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+      { # Creative optimization settings.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+    ],
+    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+      { # Audience Segment Group.
+        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+          { # Audience Segment.
+            "allocation": 42, # 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.
+            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+          },
+        ],
+        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM campaign.
+      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+      "traffickerEmails": [ # Campaign trafficker contact emails.
+        "A String",
+      ],
+      "archived": True or False, # Whether this campaign has been archived.
+      "externalId": "A String", # External ID for this campaign.
+      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+        "A String",
+      ],
+      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+        { # Creative optimization settings.
+          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+            { # Creative optimization activity.
+              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+              "weight": 42, # 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.
+            },
+          ],
+          "optimizationModel": "A String", # Optimization model for this configuration.
+          "id": "A String", # 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.
+          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+        },
+      ],
+      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+        { # Audience Segment Group.
+          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+            { # Audience Segment.
+              "allocation": 42, # 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.
+              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+            },
+          ],
+          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+        },
+      ],
+    }
+
+ +
+ update(profileId, body) +
Updates an existing campaign.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM campaign.
+    "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+    "startDate": "A String", # 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.
+    "endDate": "A String", # 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.
+    "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+      "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+      "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+    },
+    "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+      { # Event tag override information.
+        "enabled": True or False, # Whether this override is enabled.
+        "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+      },
+    ],
+    "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+      "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+        { # Creative optimization activity.
+          "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+          "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "weight": 42, # 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.
+        },
+      ],
+      "optimizationModel": "A String", # Optimization model for this configuration.
+      "id": "A String", # 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.
+      "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+    },
+    "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+    "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+    "traffickerEmails": [ # Campaign trafficker contact emails.
+      "A String",
+    ],
+    "archived": True or False, # Whether this campaign has been archived.
+    "externalId": "A String", # External ID for this campaign.
+    "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+    "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+    "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+      "A String",
+    ],
+    "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+      { # Creative optimization settings.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+    ],
+    "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+      "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+      "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+    },
+    "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+    "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+      { # Audience Segment Group.
+        "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+          { # Audience Segment.
+            "allocation": 42, # 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.
+            "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+          },
+        ],
+        "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+      },
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM campaign.
+      "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
+        "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
+        "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
+      },
+      "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
+        { # Event tag override information.
+          "enabled": True or False, # Whether this override is enabled.
+          "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
+        },
+      ],
+      "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
+        "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+          { # Creative optimization activity.
+            "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+            "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "weight": 42, # 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.
+          },
+        ],
+        "optimizationModel": "A String", # Optimization model for this configuration.
+        "id": "A String", # 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.
+        "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+      },
+      "id": "A String", # ID of this campaign. This is a read-only auto-generated field.
+      "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
+      "traffickerEmails": [ # Campaign trafficker contact emails.
+        "A String",
+      ],
+      "archived": True or False, # Whether this campaign has been archived.
+      "externalId": "A String", # External ID for this campaign.
+      "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
+      "comscoreVceEnabled": True or False, # Whether comScore vCE reports are enabled for this campaign.
+      "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
+        "A String",
+      ],
+      "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
+        { # Creative optimization settings.
+          "optimizationActivitys": [ # List of optimization activities associated with this configuration.
+            { # Creative optimization activity.
+              "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
+              "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+              "weight": 42, # 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.
+            },
+          ],
+          "optimizationModel": "A String", # Optimization model for this configuration.
+          "id": "A String", # 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.
+          "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
+        },
+      ],
+      "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
+        "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
+        "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
+      },
+      "kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
+      "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
+        { # Audience Segment Group.
+          "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
+            { # Audience Segment.
+              "allocation": 42, # 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.
+              "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
+            },
+          ],
+          "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
+        },
+      ],
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.changeLogs.html b/docs/dyn/dfareporting_v2_4.changeLogs.html new file mode 100644 index 00000000000..8fb71076297 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.changeLogs.html @@ -0,0 +1,230 @@ + + + +

DCM/DFA Reporting And Trafficking API . changeLogs

+

Instance Methods

+

+ get(profileId, id)

+

Gets one change log by ID.

+

+ list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None)

+

Retrieves a list of change logs.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, id) +
Gets one change log by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Change log ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Describes a change that a user has made to a resource.
+    "changeTime": "A String", # Time when the object was modified.
+    "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
+    "subaccountId": "A String", # Subaccount ID of the modified object.
+    "userProfileId": "A String", # ID of the user who modified the object.
+    "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
+    "newValue": "A String", # New value of the object field.
+    "userProfileName": "A String", # User profile name of the user who modified the object.
+    "fieldName": "A String", # Field name of the object which changed.
+    "oldValue": "A String", # Old value of the object field.
+    "action": "A String", # Action which caused the change.
+    "transactionId": "A String", # 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.
+    "objectType": "A String", # Object type of the change log.
+    "id": "A String", # ID of this change log.
+    "accountId": "A String", # Account ID of the modified object.
+  }
+
+ +
+ list(profileId, objectType=None, maxChangeTime=None, pageToken=None, maxResults=None, action=None, minChangeTime=None, searchString=None, userProfileIds=None, ids=None, objectIds=None) +
Retrieves a list of change logs.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  objectType: string, Select only change logs with the specified object type.
+    Allowed values
+      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 - 
+  maxChangeTime: string, 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.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  maxResults: integer, Maximum number of results to return.
+  action: string, Select only change logs with the specified action.
+    Allowed values
+      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 - 
+  minChangeTime: string, 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.
+  searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
+  userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
+  ids: string, Select only change logs with these IDs. (repeated)
+  objectIds: string, Select only change logs with these object IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Change Log List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#changeLogsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse".
+    "changeLogs": [ # Change log collection.
+      { # Describes a change that a user has made to a resource.
+        "changeTime": "A String", # Time when the object was modified.
+        "kind": "dfareporting#changeLog", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog".
+        "subaccountId": "A String", # Subaccount ID of the modified object.
+        "userProfileId": "A String", # ID of the user who modified the object.
+        "objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
+        "newValue": "A String", # New value of the object field.
+        "userProfileName": "A String", # User profile name of the user who modified the object.
+        "fieldName": "A String", # Field name of the object which changed.
+        "oldValue": "A String", # Old value of the object field.
+        "action": "A String", # Action which caused the change.
+        "transactionId": "A String", # 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.
+        "objectType": "A String", # Object type of the change log.
+        "id": "A String", # ID of this change log.
+        "accountId": "A String", # Account ID of the modified object.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.cities.html b/docs/dyn/dfareporting_v2_4.cities.html new file mode 100644 index 00000000000..65d5c204686 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.cities.html @@ -0,0 +1,113 @@ + + + +

DCM/DFA Reporting And Trafficking API . cities

+

Instance Methods

+

+ list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None)

+

Retrieves a list of cities, possibly filtered.

+

Method Details

+
+ list(profileId, dartIds=None, namePrefix=None, regionDartIds=None, countryDartIds=None) +
Retrieves a list of cities, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  dartIds: string, Select only cities with these DART IDs. (repeated)
+  namePrefix: string, Select only cities with names starting with this prefix.
+  regionDartIds: string, Select only cities from these regions. (repeated)
+  countryDartIds: string, Select only cities from these countries. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # City List Response
+    "kind": "dfareporting#citiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#citiesListResponse".
+    "cities": [ # City collection.
+      { # Contains information about a city that can be targeted by ads.
+        "kind": "dfareporting#city", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#city".
+        "countryDartId": "A String", # DART ID of the country to which this city belongs.
+        "name": "A String", # Name of this city.
+        "countryCode": "A String", # Country code of the country to which this city belongs.
+        "metroCode": "A String", # Metro region code of the metro region (DMA) to which this city belongs.
+        "regionCode": "A String", # Region code of the region to which this city belongs.
+        "metroDmaId": "A String", # ID of the metro region (DMA) to which this city belongs.
+        "dartId": "A String", # DART ID of this city. This is the ID used for targeting and generating reports.
+        "regionDartId": "A String", # DART ID of the region to which this city belongs.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.connectionTypes.html b/docs/dyn/dfareporting_v2_4.connectionTypes.html new file mode 100644 index 00000000000..dfa2e97b732 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.connectionTypes.html @@ -0,0 +1,124 @@ + + + +

DCM/DFA Reporting And Trafficking API . connectionTypes

+

Instance Methods

+

+ get(profileId, id)

+

Gets one connection type by ID.

+

+ list(profileId)

+

Retrieves a list of connection types.

+

Method Details

+
+ get(profileId, id) +
Gets one connection type by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Connection type ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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.
+    "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+    "id": "A String", # ID of this connection type.
+    "name": "A String", # Name of this connection type.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of connection types.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Connection Type List Response
+    "kind": "dfareporting#connectionTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionTypesListResponse".
+    "connectionTypes": [ # Collection of connection types such as broadband and mobile.
+      { # 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.
+        "kind": "dfareporting#connectionType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#connectionType".
+        "id": "A String", # ID of this connection type.
+        "name": "A String", # Name of this connection type.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.contentCategories.html b/docs/dyn/dfareporting_v2_4.contentCategories.html new file mode 100644 index 00000000000..d02867ec5a9 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.contentCategories.html @@ -0,0 +1,263 @@ + + + +

DCM/DFA Reporting And Trafficking API . contentCategories

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing content category.

+

+ get(profileId, id)

+

Gets one content category by ID.

+

+ insert(profileId, body)

+

Inserts a new content category.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of content categories, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing content category. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing content category.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing content category.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Content category ID. (required)
+
+
+ +
+ get(profileId, id) +
Gets one content category by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Content category ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Organizes placements according to the contents of their associated webpages.
+      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new content category.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Organizes placements according to the contents of their associated webpages.
+      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of content categories, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only content categories with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Content Category List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#contentCategoriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategoriesListResponse".
+    "contentCategories": [ # Content category collection.
+      { # Organizes placements according to the contents of their associated webpages.
+          "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+          "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+          "name": "A String", # 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.
+          "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing content category. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Content category ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Organizes placements according to the contents of their associated webpages.
+      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing content category.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Organizes placements according to the contents of their associated webpages.
+    "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+    "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Organizes placements according to the contents of their associated webpages.
+      "kind": "dfareporting#contentCategory", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#contentCategory".
+      "id": "A String", # ID of this content category. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this content category. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.countries.html b/docs/dyn/dfareporting_v2_4.countries.html new file mode 100644 index 00000000000..7475fa1c48b --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.countries.html @@ -0,0 +1,128 @@ + + + +

DCM/DFA Reporting And Trafficking API . countries

+

Instance Methods

+

+ get(profileId, dartId)

+

Gets one country by ID.

+

+ list(profileId)

+

Retrieves a list of countries.

+

Method Details

+
+ get(profileId, dartId) +
Gets one country by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  dartId: string, Country DART ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about a country that can be targeted by ads.
+    "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+    "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+    "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+    "countryCode": "A String", # Country code.
+    "name": "A String", # Name of this country.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of countries.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Country List Response
+    "kind": "dfareporting#countriesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#countriesListResponse".
+    "countries": [ # Country collection.
+      { # Contains information about a country that can be targeted by ads.
+        "dartId": "A String", # DART ID of this country. This is the ID used for targeting and generating reports.
+        "sslEnabled": True or False, # Whether ad serving supports secure servers in this country.
+        "kind": "dfareporting#country", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#country".
+        "countryCode": "A String", # Country code.
+        "name": "A String", # Name of this country.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.creativeAssets.html b/docs/dyn/dfareporting_v2_4.creativeAssets.html new file mode 100644 index 00000000000..c1e40f67492 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.creativeAssets.html @@ -0,0 +1,185 @@ + + + +

DCM/DFA Reporting And Trafficking API . creativeAssets

+

Instance Methods

+

+ insert(profileId, advertiserId, body=None, media_body=None)

+

Inserts a new creative asset.

+

Method Details

+
+ insert(profileId, advertiserId, body=None, media_body=None) +
Inserts a new creative asset.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  advertiserId: string, Advertiser ID of this creative. This is a required field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # 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.
+    "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
+        # 
+        # Possible values are:
+        # - "CLICK_TAG_NON_TOP_LEVEL"
+        # - "CLICK_TAG_MISSING"
+        # - "CLICK_TAG_MORE_THAN_ONE"
+        # - "CLICK_TAG_INVALID"
+        # - "ORPHANED_ASSET"
+        # - "PRIMARY_HTML_MISSING"
+        # - "EXTERNAL_FILE_REFERENCED"
+        # - "MRAID_REFERENCED"
+        # - "ADMOB_REFERENCED"
+        # - "FILE_TYPE_INVALID"
+        # - "ZIP_INVALID"
+        # - "LINKED_FILE_NOT_FOUND"
+        # - "MAX_FLASH_VERSION_11"
+        # - "NOT_SSL_COMPLIANT"
+        # - "FILE_DETAIL_EMPTY"
+        # - "ASSET_INVALID"
+        # - "GWD_PROPERTIES_INVALID"
+        # - "ENABLER_UNSUPPORTED_METHOD_DCM"
+        # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+        # - "COMPONENT_UNSUPPORTED_DCM"
+        # - "HTML5_FEATURE_UNSUPPORTED' "
+      "A String",
+    ],
+    "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
+      { # Creative Click Tag.
+        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+        "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+      },
+    ],
+    "detectedFeatures": [ # 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.
+      "A String",
+    ],
+    "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
+    "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
+      "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+      "name": "A String", # 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.
+    },
+  }
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "warnedValidationRules": [ # Rules validated during code generation that generated a warning. This is a read-only, auto-generated field.
+          #
+          # Possible values are:
+          # - "CLICK_TAG_NON_TOP_LEVEL"
+          # - "CLICK_TAG_MISSING"
+          # - "CLICK_TAG_MORE_THAN_ONE"
+          # - "CLICK_TAG_INVALID"
+          # - "ORPHANED_ASSET"
+          # - "PRIMARY_HTML_MISSING"
+          # - "EXTERNAL_FILE_REFERENCED"
+          # - "MRAID_REFERENCED"
+          # - "ADMOB_REFERENCED"
+          # - "FILE_TYPE_INVALID"
+          # - "ZIP_INVALID"
+          # - "LINKED_FILE_NOT_FOUND"
+          # - "MAX_FLASH_VERSION_11"
+          # - "NOT_SSL_COMPLIANT"
+          # - "FILE_DETAIL_EMPTY"
+          # - "ASSET_INVALID"
+          # - "GWD_PROPERTIES_INVALID"
+          # - "ENABLER_UNSUPPORTED_METHOD_DCM"
+          # - "ASSET_FORMAT_UNSUPPORTED_DCM"
+          # - "COMPONENT_UNSUPPORTED_DCM"
+          # - "HTML5_FEATURE_UNSUPPORTED' "
+        "A String",
+      ],
+      "clickTags": [ # List of detected click tags for assets. This is a read-only auto-generated field.
+        { # Creative Click Tag.
+          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+          "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+        },
+      ],
+      "detectedFeatures": [ # 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.
+        "A String",
+      ],
+      "kind": "dfareporting#creativeAssetMetadata", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeAssetMetadata".
+      "assetIdentifier": { # Creative Asset ID. # ID of the creative asset. This is a required field.
+        "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+        "name": "A String", # 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.
+      },
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.creativeFieldValues.html b/docs/dyn/dfareporting_v2_4.creativeFieldValues.html new file mode 100644 index 00000000000..5c233ee71b3 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.creativeFieldValues.html @@ -0,0 +1,261 @@ + + + +

DCM/DFA Reporting And Trafficking API . creativeFieldValues

+

Instance Methods

+

+ delete(profileId, creativeFieldId, id)

+

Deletes an existing creative field value.

+

+ get(profileId, creativeFieldId, id)

+

Gets one creative field value by ID.

+

+ insert(profileId, creativeFieldId, body)

+

Inserts a new creative field value.

+

+ list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None)

+

Retrieves a list of creative field values, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, creativeFieldId, id, body)

+

Updates an existing creative field value. This method supports patch semantics.

+

+ update(profileId, creativeFieldId, body)

+

Updates an existing creative field value.

+

Method Details

+
+ delete(profileId, creativeFieldId, id) +
Deletes an existing creative field value.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  id: string, Creative Field Value ID (required)
+
+
+ +
+ get(profileId, creativeFieldId, id) +
Gets one creative field value by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  id: string, Creative Field Value ID (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field value.
+      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+    }
+
+ +
+ insert(profileId, creativeFieldId, body) +
Inserts a new creative field value.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field value.
+    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field value.
+      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+    }
+
+ +
+ list(profileId, creativeFieldId, searchString=None, sortField=None, ids=None, maxResults=None, pageToken=None, sortOrder=None) +
Retrieves a list of creative field values, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  searchString: string, Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      VALUE - 
+  ids: string, Select only creative field values with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Creative Field Value List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#creativeFieldValuesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValuesListResponse".
+    "creativeFieldValues": [ # Creative field value collection.
+      { # Contains properties of a creative field value.
+          "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+          "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+          "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, creativeFieldId, id, body) +
Updates an existing creative field value. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  id: string, Creative Field Value ID (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field value.
+    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field value.
+      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+    }
+
+ +
+ update(profileId, creativeFieldId, body) +
Updates an existing creative field value.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  creativeFieldId: string, Creative field ID for this creative field value. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field value.
+    "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+    "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+    "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field value.
+      "kind": "dfareporting#creativeFieldValue", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldValue".
+      "id": "A String", # ID of this creative field value. This is a read-only, auto-generated field.
+      "value": "A String", # Value of this creative field value. It needs to be less than 256 characters in length and unique per creative field.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.creativeFields.html b/docs/dyn/dfareporting_v2_4.creativeFields.html new file mode 100644 index 00000000000..3090c0b152a --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.creativeFields.html @@ -0,0 +1,344 @@ + + + +

DCM/DFA Reporting And Trafficking API . creativeFields

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing creative field.

+

+ get(profileId, id)

+

Gets one creative field by ID.

+

+ insert(profileId, body)

+

Inserts a new creative field.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of creative fields, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing creative field. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing creative field.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing creative field.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative Field ID (required)
+
+
+ +
+ get(profileId, id) +
Gets one creative field by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative Field ID (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field.
+      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new creative field.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field.
+    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field.
+      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of creative fields, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  advertiserIds: string, Select only creative fields that belong to these advertisers. (repeated)
+  ids: string, Select only creative fields with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Creative Field List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "creativeFields": [ # Creative field collection.
+      { # Contains properties of a creative field.
+          "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+          "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+          "name": "A String", # 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.
+          "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#creativeFieldsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeFieldsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing creative field. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative Field ID (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field.
+    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field.
+      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing creative field.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative field.
+    "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+    "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative field.
+      "kind": "dfareporting#creativeField", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeField".
+      "subaccountId": "A String", # Subaccount ID of this creative field. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "advertiserId": "A String", # Advertiser ID of this creative field. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative field. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative field. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.creativeGroups.html b/docs/dyn/dfareporting_v2_4.creativeGroups.html new file mode 100644 index 00000000000..ede5cb1b24d --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.creativeGroups.html @@ -0,0 +1,364 @@ + + + +

DCM/DFA Reporting And Trafficking API . creativeGroups

+

Instance Methods

+

+ get(profileId, id)

+

Gets one creative group by ID.

+

+ insert(profileId, body)

+

Inserts a new creative group.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None)

+

Retrieves a list of creative groups, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing creative group. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing creative group.

+

Method Details

+
+ get(profileId, id) +
Gets one creative group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative group.
+      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "groupNumber": 42, # 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.
+          # Acceptable values are:
+          # - 1
+          # - 2
+      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new creative group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative group.
+    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "groupNumber": 42, # 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.
+        # Acceptable values are:
+        # - 1
+        # - 2
+    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative group.
+      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "groupNumber": 42, # 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.
+          # Acceptable values are:
+          # - 1
+          # - 2
+      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, groupNumber=None, maxResults=None, ids=None, sortOrder=None) +
Retrieves a list of creative groups, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  advertiserIds: string, Select only creative groups that belong to these advertisers. (repeated)
+  groupNumber: integer, Select only creative groups that belong to this subgroup.
+  maxResults: integer, Maximum number of results to return.
+  ids: string, Select only creative groups with these IDs. (repeated)
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Creative Group List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "creativeGroups": [ # Creative group collection.
+      { # Contains properties of a creative group.
+          "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+          "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+          "name": "A String", # 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.
+          "groupNumber": 42, # 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.
+              # Acceptable values are:
+              # - 1
+              # - 2
+          "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#creativeGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroupsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing creative group. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative group ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative group.
+    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "groupNumber": 42, # 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.
+        # Acceptable values are:
+        # - 1
+        # - 2
+    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative group.
+      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "groupNumber": 42, # 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.
+          # Acceptable values are:
+          # - 1
+          # - 2
+      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing creative group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a creative group.
+    "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+    "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "groupNumber": 42, # 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.
+        # Acceptable values are:
+        # - 1
+        # - 2
+    "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a creative group.
+      "kind": "dfareporting#creativeGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativeGroup".
+      "subaccountId": "A String", # Subaccount ID of this creative group. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "groupNumber": 42, # 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.
+          # Acceptable values are:
+          # - 1
+          # - 2
+      "advertiserId": "A String", # Advertiser ID of this creative group. This is a required field on insertion.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this creative group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this creative group. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.creatives.html b/docs/dyn/dfareporting_v2_4.creatives.html new file mode 100644 index 00000000000..985823e3356 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.creatives.html @@ -0,0 +1,2893 @@ + + + +

DCM/DFA Reporting And Trafficking API . creatives

+

Instance Methods

+

+ get(profileId, id)

+

Gets one creative by ID.

+

+ insert(profileId, body)

+

Inserts a new creative.

+

+ list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None)

+

Retrieves a list of creatives, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing creative. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing creative.

+

Method Details

+
+ get(profileId, id) +
Gets one creative by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Creative.
+      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+        { # Third-party Tracking URL.
+          "url": "A String", # URL for the specified third-party URL type.
+          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+        },
+      ],
+      "artworkType": "A String", # 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.
+      "latestTraffickedCreativeId": "A String", # 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.
+      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+      "requiredFlashPluginVersion": "A String", # 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.
+      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+      "timerCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "fsCommand": { # FsCommand. # 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.
+        "windowHeight": 42, # Height of the window.
+        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+        "windowWidth": 42, # Width of the window.
+        "positionOption": "A String", # Position in the browser where the window will open.
+        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      },
+      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+      "accountId": "A String", # 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.
+      "studioTraffickedCreativeId": "A String", # 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.
+      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+      "requiredFlashVersion": 42, # 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.
+      "exitCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+      "counterCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+      "version": 42, # 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.
+      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+        { # Creative Field Assignment.
+          "creativeFieldId": "A String", # ID of the creative field.
+          "creativeFieldValueId": "A String", # ID of the creative field value.
+        },
+      ],
+      "backgroundColor": "A String", # 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.
+      "customKeyValues": [ # 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.
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "htmlCode": "A String", # 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.
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+      "studioAdvertiserId": "A String", # 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.
+      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+        { # Creative Asset.
+          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "flashVersion": 42, # 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.
+          "pushdown": True or False, # 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.
+          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "detectedFeatures": [ # 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.
+            "A String",
+          ],
+          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+          "positionTopUnit": "A String", # 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.
+          "id": "A String", # 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.
+          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "role": "A String", # 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.
+              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # ALTERNATE_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.
+              # For 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.
+          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "windowMode": "A String", # 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.
+          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "fileSize": "A String", # 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.
+          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "offset": { # Offset Position. # 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.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "active": True or False, # 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.
+          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "zIndex": 42, # 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.
+          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+            "targetType": "A String", # Target type used by the event.
+            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+              "showStatusBar": True or False, # Whether to display the browser status bar.
+              "showScrollBar": True or False, # Whether to display the browser scroll bar.
+              "showAddressBar": True or False, # Whether to display the browser address bar.
+              "showMenuBar": True or False, # Whether to display the browser menu bar.
+              "title": "A String", # Title of popup window.
+              "showToolBar": True or False, # Whether to display the browser tool bar.
+              "positionType": "A String", # Popup window position either centered or at specific coordinate.
+              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+            },
+            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+            "artworkLabel": "A String", # 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.
+            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+            "advertiserCustomEventName": "A String", # User-entered name for the event.
+          },
+          "actionScript3": True or False, # 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.
+          "pushdownDuration": 3.14, # 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.
+          "assetIdentifier": { # Creative Asset ID. # 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.
+            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+            "name": "A String", # 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.
+          },
+          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+          "sslCompliant": True or False, # 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.
+          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        },
+      ],
+      "redirectUrl": "A String", # 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
+      "videoDuration": 3.14, # 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.
+      "htmlCodeLocked": True or False, # 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.
+      "convertFlashToHtml5": True or False, # 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.
+      "clickTags": [ # 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.
+        { # Creative Click Tag.
+          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+          "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+        },
+      ],
+      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "active": True or False, # Whether the creative is active. Applicable to all creative types.
+      "compatibility": [ # 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.
+          #
+          # Acceptable values are:
+          # - "APP"
+          # - "APP_INTERSTITIAL"
+          # - "IN_STREAM_VIDEO"
+          # - "DISPLAY"
+          # - "DISPLAY_INTERSTITIAL"
+        "A String",
+      ],
+      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+      "adTagKeys": [ # 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.
+        "A String",
+      ],
+      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+      "subaccountId": "A String", # 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.
+      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+      "studioCreativeId": "A String", # 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.
+      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+      "allowScriptAccess": True or False, # 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.
+      "companionCreatives": [ # 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.
+        "A String",
+      ],
+      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+      "backupImageFeatures": [ # 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.
+        "A String",
+      ],
+      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+        "customHtml": "A String", # User-entered value.
+        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+      },
+      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new creative.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Creative.
+    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      { # Third-party Tracking URL.
+        "url": "A String", # URL for the specified third-party URL type.
+        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+      },
+    ],
+    "artworkType": "A String", # 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.
+    "latestTraffickedCreativeId": "A String", # 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.
+    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+    "requiredFlashPluginVersion": "A String", # 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.
+    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+    "timerCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "fsCommand": { # FsCommand. # 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.
+      "windowHeight": 42, # Height of the window.
+      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      "windowWidth": 42, # Width of the window.
+      "positionOption": "A String", # Position in the browser where the window will open.
+      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+    },
+    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+    "accountId": "A String", # 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.
+    "studioTraffickedCreativeId": "A String", # 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.
+    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+    "requiredFlashVersion": 42, # 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.
+    "exitCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+    "counterCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+    "version": 42, # 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.
+    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+      { # Creative Field Assignment.
+        "creativeFieldId": "A String", # ID of the creative field.
+        "creativeFieldValueId": "A String", # ID of the creative field value.
+      },
+    ],
+    "backgroundColor": "A String", # 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.
+    "customKeyValues": [ # 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.
+      "A String",
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "htmlCode": "A String", # 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.
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+    "studioAdvertiserId": "A String", # 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.
+    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+      { # Creative Asset.
+        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "flashVersion": 42, # 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.
+        "pushdown": True or False, # 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.
+        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "detectedFeatures": [ # 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.
+          "A String",
+        ],
+        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+        "positionTopUnit": "A String", # 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.
+        "id": "A String", # 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.
+        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "role": "A String", # 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.
+            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # ALTERNATE_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.
+            # For 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.
+        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "windowMode": "A String", # 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.
+        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "fileSize": "A String", # 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.
+        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "offset": { # Offset Position. # 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.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "active": True or False, # 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.
+        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "zIndex": 42, # 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.
+        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+        "actionScript3": True or False, # 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.
+        "pushdownDuration": 3.14, # 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.
+        "assetIdentifier": { # Creative Asset ID. # 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.
+          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+          "name": "A String", # 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.
+        },
+        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+        "sslCompliant": True or False, # 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.
+        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+      },
+    ],
+    "redirectUrl": "A String", # 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
+    "videoDuration": 3.14, # 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.
+    "htmlCodeLocked": True or False, # 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.
+    "convertFlashToHtml5": True or False, # 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.
+    "clickTags": [ # 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.
+      { # Creative Click Tag.
+        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+        "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+      },
+    ],
+    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "active": True or False, # Whether the creative is active. Applicable to all creative types.
+    "compatibility": [ # 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.
+        # 
+        # Acceptable values are:
+        # - "APP"
+        # - "APP_INTERSTITIAL"
+        # - "IN_STREAM_VIDEO"
+        # - "DISPLAY"
+        # - "DISPLAY_INTERSTITIAL"
+      "A String",
+    ],
+    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+    "adTagKeys": [ # 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.
+      "A String",
+    ],
+    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+    "subaccountId": "A String", # 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.
+    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+    "studioCreativeId": "A String", # 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.
+    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+    "allowScriptAccess": True or False, # 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.
+    "companionCreatives": [ # 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.
+      "A String",
+    ],
+    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+    "backupImageFeatures": [ # 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.
+      "A String",
+    ],
+    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "customHtml": "A String", # User-entered value.
+      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+    },
+    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Creative.
+      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+        { # Third-party Tracking URL.
+          "url": "A String", # URL for the specified third-party URL type.
+          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+        },
+      ],
+      "artworkType": "A String", # 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.
+      "latestTraffickedCreativeId": "A String", # 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.
+      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+      "requiredFlashPluginVersion": "A String", # 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.
+      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+      "timerCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "fsCommand": { # FsCommand. # 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.
+        "windowHeight": 42, # Height of the window.
+        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+        "windowWidth": 42, # Width of the window.
+        "positionOption": "A String", # Position in the browser where the window will open.
+        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      },
+      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+      "accountId": "A String", # 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.
+      "studioTraffickedCreativeId": "A String", # 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.
+      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+      "requiredFlashVersion": 42, # 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.
+      "exitCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+      "counterCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+      "version": 42, # 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.
+      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+        { # Creative Field Assignment.
+          "creativeFieldId": "A String", # ID of the creative field.
+          "creativeFieldValueId": "A String", # ID of the creative field value.
+        },
+      ],
+      "backgroundColor": "A String", # 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.
+      "customKeyValues": [ # 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.
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "htmlCode": "A String", # 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.
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+      "studioAdvertiserId": "A String", # 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.
+      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+        { # Creative Asset.
+          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "flashVersion": 42, # 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.
+          "pushdown": True or False, # 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.
+          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "detectedFeatures": [ # 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.
+            "A String",
+          ],
+          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+          "positionTopUnit": "A String", # 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.
+          "id": "A String", # 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.
+          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "role": "A String", # 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.
+              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # ALTERNATE_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.
+              # For 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.
+          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "windowMode": "A String", # 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.
+          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "fileSize": "A String", # 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.
+          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "offset": { # Offset Position. # 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.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "active": True or False, # 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.
+          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "zIndex": 42, # 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.
+          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+            "targetType": "A String", # Target type used by the event.
+            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+              "showStatusBar": True or False, # Whether to display the browser status bar.
+              "showScrollBar": True or False, # Whether to display the browser scroll bar.
+              "showAddressBar": True or False, # Whether to display the browser address bar.
+              "showMenuBar": True or False, # Whether to display the browser menu bar.
+              "title": "A String", # Title of popup window.
+              "showToolBar": True or False, # Whether to display the browser tool bar.
+              "positionType": "A String", # Popup window position either centered or at specific coordinate.
+              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+            },
+            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+            "artworkLabel": "A String", # 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.
+            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+            "advertiserCustomEventName": "A String", # User-entered name for the event.
+          },
+          "actionScript3": True or False, # 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.
+          "pushdownDuration": 3.14, # 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.
+          "assetIdentifier": { # Creative Asset ID. # 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.
+            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+            "name": "A String", # 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.
+          },
+          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+          "sslCompliant": True or False, # 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.
+          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        },
+      ],
+      "redirectUrl": "A String", # 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
+      "videoDuration": 3.14, # 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.
+      "htmlCodeLocked": True or False, # 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.
+      "convertFlashToHtml5": True or False, # 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.
+      "clickTags": [ # 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.
+        { # Creative Click Tag.
+          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+          "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+        },
+      ],
+      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "active": True or False, # Whether the creative is active. Applicable to all creative types.
+      "compatibility": [ # 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.
+          #
+          # Acceptable values are:
+          # - "APP"
+          # - "APP_INTERSTITIAL"
+          # - "IN_STREAM_VIDEO"
+          # - "DISPLAY"
+          # - "DISPLAY_INTERSTITIAL"
+        "A String",
+      ],
+      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+      "adTagKeys": [ # 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.
+        "A String",
+      ],
+      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+      "subaccountId": "A String", # 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.
+      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+      "studioCreativeId": "A String", # 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.
+      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+      "allowScriptAccess": True or False, # 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.
+      "companionCreatives": [ # 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.
+        "A String",
+      ],
+      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+      "backupImageFeatures": [ # 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.
+        "A String",
+      ],
+      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+        "customHtml": "A String", # User-entered value.
+        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+      },
+      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    }
+
+ +
+ list(profileId, campaignId=None, advertiserId=None, sizeIds=None, archived=None, pageToken=None, sortOrder=None, renderingIds=None, maxResults=None, active=None, companionCreativeIds=None, types=None, searchString=None, ids=None, studioCreativeId=None, sortField=None, creativeFieldIds=None) +
Retrieves a list of creatives, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Select only creatives with this campaign ID.
+  advertiserId: string, Select only creatives with this advertiser ID.
+  sizeIds: string, Select only creatives with these size IDs. (repeated)
+  archived: boolean, Select only archived creatives. Leave blank to select archived and unarchived creatives.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  renderingIds: string, Select only creatives with these rendering IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  active: boolean, Select only active creatives. Leave blank to select active and inactive creatives.
+  companionCreativeIds: string, Select only in-stream video creatives with these companion IDs. (repeated)
+  types: string, Select only creatives with these creative types. (repeated)
+    Allowed values
+      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 - 
+  searchString: string, 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".
+  ids: string, Select only creatives with these IDs. (repeated)
+  studioCreativeId: string, Select only creatives corresponding to this Studio creative ID.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  creativeFieldIds: string, Select only creatives with these creative field IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Creative List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#creativesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creativesListResponse".
+    "creatives": [ # Creative collection.
+      { # Contains properties of a Creative.
+          "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+            { # Third-party Tracking URL.
+              "url": "A String", # URL for the specified third-party URL type.
+              "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+            },
+          ],
+          "artworkType": "A String", # 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.
+          "latestTraffickedCreativeId": "A String", # 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.
+          "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+          "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+          "requiredFlashPluginVersion": "A String", # 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.
+          "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+          "timerCustomEvents": [ # 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.
+            { # Creative Custom Event.
+              "targetType": "A String", # Target type used by the event.
+              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+                "showStatusBar": True or False, # Whether to display the browser status bar.
+                "showScrollBar": True or False, # Whether to display the browser scroll bar.
+                "showAddressBar": True or False, # Whether to display the browser address bar.
+                "showMenuBar": True or False, # Whether to display the browser menu bar.
+                "title": "A String", # Title of popup window.
+                "showToolBar": True or False, # Whether to display the browser tool bar.
+                "positionType": "A String", # Popup window position either centered or at specific coordinate.
+                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                  "top": 42, # Offset distance from top side of an asset or a window.
+                  "left": 42, # Offset distance from left side of an asset or a window.
+                },
+                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                  "width": 42, # Width of this size.
+                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                  "height": 42, # Height of this size.
+                },
+              },
+              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+              "artworkLabel": "A String", # 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.
+              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+              "advertiserCustomEventName": "A String", # User-entered name for the event.
+            },
+          ],
+          "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "fsCommand": { # FsCommand. # 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.
+            "windowHeight": 42, # Height of the window.
+            "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+            "windowWidth": 42, # Width of the window.
+            "positionOption": "A String", # Position in the browser where the window will open.
+            "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+          },
+          "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+          "accountId": "A String", # 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.
+          "studioTraffickedCreativeId": "A String", # 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.
+          "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+          "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+          "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+          "requiredFlashVersion": 42, # 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.
+          "exitCustomEvents": [ # 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.
+            { # Creative Custom Event.
+              "targetType": "A String", # Target type used by the event.
+              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+                "showStatusBar": True or False, # Whether to display the browser status bar.
+                "showScrollBar": True or False, # Whether to display the browser scroll bar.
+                "showAddressBar": True or False, # Whether to display the browser address bar.
+                "showMenuBar": True or False, # Whether to display the browser menu bar.
+                "title": "A String", # Title of popup window.
+                "showToolBar": True or False, # Whether to display the browser tool bar.
+                "positionType": "A String", # Popup window position either centered or at specific coordinate.
+                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                  "top": 42, # Offset distance from top side of an asset or a window.
+                  "left": 42, # Offset distance from left side of an asset or a window.
+                },
+                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                  "width": 42, # Width of this size.
+                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                  "height": 42, # Height of this size.
+                },
+              },
+              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+              "artworkLabel": "A String", # 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.
+              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+              "advertiserCustomEventName": "A String", # User-entered name for the event.
+            },
+          ],
+          "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+          "counterCustomEvents": [ # 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.
+            { # Creative Custom Event.
+              "targetType": "A String", # Target type used by the event.
+              "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+              "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+              "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+                "showStatusBar": True or False, # Whether to display the browser status bar.
+                "showScrollBar": True or False, # Whether to display the browser scroll bar.
+                "showAddressBar": True or False, # Whether to display the browser address bar.
+                "showMenuBar": True or False, # Whether to display the browser menu bar.
+                "title": "A String", # Title of popup window.
+                "showToolBar": True or False, # Whether to display the browser tool bar.
+                "positionType": "A String", # Popup window position either centered or at specific coordinate.
+                "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                  "top": 42, # Offset distance from top side of an asset or a window.
+                  "left": 42, # Offset distance from left side of an asset or a window.
+                },
+                "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                  "width": 42, # Width of this size.
+                  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                  "height": 42, # Height of this size.
+                },
+              },
+              "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+              "artworkLabel": "A String", # 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.
+              "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+              "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+              "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+              "advertiserCustomEventName": "A String", # User-entered name for the event.
+            },
+          ],
+          "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+          "version": 42, # 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.
+          "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+            { # Creative Field Assignment.
+              "creativeFieldId": "A String", # ID of the creative field.
+              "creativeFieldValueId": "A String", # ID of the creative field value.
+            },
+          ],
+          "backgroundColor": "A String", # 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.
+          "customKeyValues": [ # 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.
+            "A String",
+          ],
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "htmlCode": "A String", # 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.
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+          "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+          "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+          "studioAdvertiserId": "A String", # 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.
+          "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+            { # Creative Asset.
+              "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+              "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+              "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+              "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+              "flashVersion": 42, # 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.
+              "pushdown": True or False, # 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.
+              "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+              "detectedFeatures": [ # 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.
+                "A String",
+              ],
+              "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+              "positionTopUnit": "A String", # 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.
+              "id": "A String", # 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.
+              "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+              "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+              "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+              "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+              "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+              "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+              "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+              "role": "A String", # 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.
+                  # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+                  # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+                  # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+                  # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+                  # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+                  # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+                  # ALTERNATE_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.
+                  # For 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.
+              "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+              "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+              "windowMode": "A String", # 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.
+              "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+              "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+              "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+              "fileSize": "A String", # 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.
+              "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+              "offset": { # Offset Position. # 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.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "active": True or False, # 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.
+              "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+              "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+              "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+              "zIndex": 42, # 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.
+              "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+              "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+                "targetType": "A String", # Target type used by the event.
+                "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+                "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+                "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+                  "showStatusBar": True or False, # Whether to display the browser status bar.
+                  "showScrollBar": True or False, # Whether to display the browser scroll bar.
+                  "showAddressBar": True or False, # Whether to display the browser address bar.
+                  "showMenuBar": True or False, # Whether to display the browser menu bar.
+                  "title": "A String", # Title of popup window.
+                  "showToolBar": True or False, # Whether to display the browser tool bar.
+                  "positionType": "A String", # Popup window position either centered or at specific coordinate.
+                  "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                    "top": 42, # Offset distance from top side of an asset or a window.
+                    "left": 42, # Offset distance from left side of an asset or a window.
+                  },
+                  "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                    "width": 42, # Width of this size.
+                    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                    "height": 42, # Height of this size.
+                  },
+                },
+                "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+                "artworkLabel": "A String", # 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.
+                "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+                "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+                "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+                "advertiserCustomEventName": "A String", # User-entered name for the event.
+              },
+              "actionScript3": True or False, # 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.
+              "pushdownDuration": 3.14, # 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.
+              "assetIdentifier": { # Creative Asset ID. # 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.
+                "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+                "name": "A String", # 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.
+              },
+              "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+              "sslCompliant": True or False, # 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.
+              "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+            },
+          ],
+          "redirectUrl": "A String", # 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
+          "videoDuration": 3.14, # 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.
+          "htmlCodeLocked": True or False, # 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.
+          "convertFlashToHtml5": True or False, # 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.
+          "clickTags": [ # 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.
+            { # Creative Click Tag.
+              "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+              "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+            },
+          ],
+          "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+          "active": True or False, # Whether the creative is active. Applicable to all creative types.
+          "compatibility": [ # 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.
+              #
+              # Acceptable values are:
+              # - "APP"
+              # - "APP_INTERSTITIAL"
+              # - "IN_STREAM_VIDEO"
+              # - "DISPLAY"
+              # - "DISPLAY_INTERSTITIAL"
+            "A String",
+          ],
+          "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+          "adTagKeys": [ # 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.
+            "A String",
+          ],
+          "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+          "subaccountId": "A String", # 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.
+          "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+          "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+          "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+          "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+          "studioCreativeId": "A String", # 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.
+          "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "allowScriptAccess": True or False, # 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.
+          "companionCreatives": [ # 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.
+            "A String",
+          ],
+          "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+          "backupImageFeatures": [ # 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.
+            "A String",
+          ],
+          "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+            "customHtml": "A String", # User-entered value.
+            "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+          },
+          "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing creative. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Creative ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Creative.
+    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      { # Third-party Tracking URL.
+        "url": "A String", # URL for the specified third-party URL type.
+        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+      },
+    ],
+    "artworkType": "A String", # 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.
+    "latestTraffickedCreativeId": "A String", # 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.
+    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+    "requiredFlashPluginVersion": "A String", # 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.
+    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+    "timerCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "fsCommand": { # FsCommand. # 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.
+      "windowHeight": 42, # Height of the window.
+      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      "windowWidth": 42, # Width of the window.
+      "positionOption": "A String", # Position in the browser where the window will open.
+      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+    },
+    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+    "accountId": "A String", # 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.
+    "studioTraffickedCreativeId": "A String", # 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.
+    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+    "requiredFlashVersion": 42, # 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.
+    "exitCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+    "counterCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+    "version": 42, # 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.
+    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+      { # Creative Field Assignment.
+        "creativeFieldId": "A String", # ID of the creative field.
+        "creativeFieldValueId": "A String", # ID of the creative field value.
+      },
+    ],
+    "backgroundColor": "A String", # 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.
+    "customKeyValues": [ # 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.
+      "A String",
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "htmlCode": "A String", # 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.
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+    "studioAdvertiserId": "A String", # 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.
+    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+      { # Creative Asset.
+        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "flashVersion": 42, # 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.
+        "pushdown": True or False, # 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.
+        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "detectedFeatures": [ # 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.
+          "A String",
+        ],
+        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+        "positionTopUnit": "A String", # 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.
+        "id": "A String", # 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.
+        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "role": "A String", # 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.
+            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # ALTERNATE_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.
+            # For 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.
+        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "windowMode": "A String", # 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.
+        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "fileSize": "A String", # 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.
+        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "offset": { # Offset Position. # 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.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "active": True or False, # 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.
+        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "zIndex": 42, # 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.
+        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+        "actionScript3": True or False, # 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.
+        "pushdownDuration": 3.14, # 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.
+        "assetIdentifier": { # Creative Asset ID. # 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.
+          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+          "name": "A String", # 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.
+        },
+        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+        "sslCompliant": True or False, # 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.
+        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+      },
+    ],
+    "redirectUrl": "A String", # 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
+    "videoDuration": 3.14, # 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.
+    "htmlCodeLocked": True or False, # 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.
+    "convertFlashToHtml5": True or False, # 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.
+    "clickTags": [ # 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.
+      { # Creative Click Tag.
+        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+        "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+      },
+    ],
+    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "active": True or False, # Whether the creative is active. Applicable to all creative types.
+    "compatibility": [ # 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.
+        # 
+        # Acceptable values are:
+        # - "APP"
+        # - "APP_INTERSTITIAL"
+        # - "IN_STREAM_VIDEO"
+        # - "DISPLAY"
+        # - "DISPLAY_INTERSTITIAL"
+      "A String",
+    ],
+    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+    "adTagKeys": [ # 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.
+      "A String",
+    ],
+    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+    "subaccountId": "A String", # 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.
+    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+    "studioCreativeId": "A String", # 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.
+    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+    "allowScriptAccess": True or False, # 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.
+    "companionCreatives": [ # 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.
+      "A String",
+    ],
+    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+    "backupImageFeatures": [ # 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.
+      "A String",
+    ],
+    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "customHtml": "A String", # User-entered value.
+      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+    },
+    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Creative.
+      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+        { # Third-party Tracking URL.
+          "url": "A String", # URL for the specified third-party URL type.
+          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+        },
+      ],
+      "artworkType": "A String", # 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.
+      "latestTraffickedCreativeId": "A String", # 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.
+      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+      "requiredFlashPluginVersion": "A String", # 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.
+      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+      "timerCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "fsCommand": { # FsCommand. # 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.
+        "windowHeight": 42, # Height of the window.
+        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+        "windowWidth": 42, # Width of the window.
+        "positionOption": "A String", # Position in the browser where the window will open.
+        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      },
+      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+      "accountId": "A String", # 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.
+      "studioTraffickedCreativeId": "A String", # 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.
+      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+      "requiredFlashVersion": 42, # 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.
+      "exitCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+      "counterCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+      "version": 42, # 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.
+      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+        { # Creative Field Assignment.
+          "creativeFieldId": "A String", # ID of the creative field.
+          "creativeFieldValueId": "A String", # ID of the creative field value.
+        },
+      ],
+      "backgroundColor": "A String", # 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.
+      "customKeyValues": [ # 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.
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "htmlCode": "A String", # 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.
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+      "studioAdvertiserId": "A String", # 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.
+      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+        { # Creative Asset.
+          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "flashVersion": 42, # 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.
+          "pushdown": True or False, # 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.
+          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "detectedFeatures": [ # 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.
+            "A String",
+          ],
+          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+          "positionTopUnit": "A String", # 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.
+          "id": "A String", # 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.
+          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "role": "A String", # 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.
+              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # ALTERNATE_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.
+              # For 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.
+          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "windowMode": "A String", # 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.
+          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "fileSize": "A String", # 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.
+          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "offset": { # Offset Position. # 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.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "active": True or False, # 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.
+          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "zIndex": 42, # 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.
+          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+            "targetType": "A String", # Target type used by the event.
+            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+              "showStatusBar": True or False, # Whether to display the browser status bar.
+              "showScrollBar": True or False, # Whether to display the browser scroll bar.
+              "showAddressBar": True or False, # Whether to display the browser address bar.
+              "showMenuBar": True or False, # Whether to display the browser menu bar.
+              "title": "A String", # Title of popup window.
+              "showToolBar": True or False, # Whether to display the browser tool bar.
+              "positionType": "A String", # Popup window position either centered or at specific coordinate.
+              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+            },
+            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+            "artworkLabel": "A String", # 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.
+            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+            "advertiserCustomEventName": "A String", # User-entered name for the event.
+          },
+          "actionScript3": True or False, # 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.
+          "pushdownDuration": 3.14, # 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.
+          "assetIdentifier": { # Creative Asset ID. # 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.
+            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+            "name": "A String", # 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.
+          },
+          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+          "sslCompliant": True or False, # 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.
+          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        },
+      ],
+      "redirectUrl": "A String", # 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
+      "videoDuration": 3.14, # 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.
+      "htmlCodeLocked": True or False, # 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.
+      "convertFlashToHtml5": True or False, # 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.
+      "clickTags": [ # 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.
+        { # Creative Click Tag.
+          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+          "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+        },
+      ],
+      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "active": True or False, # Whether the creative is active. Applicable to all creative types.
+      "compatibility": [ # 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.
+          #
+          # Acceptable values are:
+          # - "APP"
+          # - "APP_INTERSTITIAL"
+          # - "IN_STREAM_VIDEO"
+          # - "DISPLAY"
+          # - "DISPLAY_INTERSTITIAL"
+        "A String",
+      ],
+      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+      "adTagKeys": [ # 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.
+        "A String",
+      ],
+      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+      "subaccountId": "A String", # 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.
+      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+      "studioCreativeId": "A String", # 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.
+      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+      "allowScriptAccess": True or False, # 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.
+      "companionCreatives": [ # 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.
+        "A String",
+      ],
+      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+      "backupImageFeatures": [ # 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.
+        "A String",
+      ],
+      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+        "customHtml": "A String", # User-entered value.
+        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+      },
+      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing creative.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Creative.
+    "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      { # Third-party Tracking URL.
+        "url": "A String", # URL for the specified third-party URL type.
+        "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+      },
+    ],
+    "artworkType": "A String", # 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.
+    "latestTraffickedCreativeId": "A String", # 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.
+    "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+    "requiredFlashPluginVersion": "A String", # 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.
+    "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+    "timerCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "fsCommand": { # FsCommand. # 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.
+      "windowHeight": 42, # Height of the window.
+      "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      "windowWidth": 42, # Width of the window.
+      "positionOption": "A String", # Position in the browser where the window will open.
+      "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+    },
+    "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+    "accountId": "A String", # 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.
+    "studioTraffickedCreativeId": "A String", # 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.
+    "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+    "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+    "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+    "requiredFlashVersion": 42, # 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.
+    "exitCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+    "counterCustomEvents": [ # 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.
+      { # Creative Custom Event.
+        "targetType": "A String", # Target type used by the event.
+        "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+        "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+        "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+          "showStatusBar": True or False, # Whether to display the browser status bar.
+          "showScrollBar": True or False, # Whether to display the browser scroll bar.
+          "showAddressBar": True or False, # Whether to display the browser address bar.
+          "showMenuBar": True or False, # Whether to display the browser menu bar.
+          "title": "A String", # Title of popup window.
+          "showToolBar": True or False, # Whether to display the browser tool bar.
+          "positionType": "A String", # Popup window position either centered or at specific coordinate.
+          "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+        },
+        "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+        "artworkLabel": "A String", # 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.
+        "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+        "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+        "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+        "advertiserCustomEventName": "A String", # User-entered name for the event.
+      },
+    ],
+    "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+    "version": 42, # 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.
+    "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+      { # Creative Field Assignment.
+        "creativeFieldId": "A String", # ID of the creative field.
+        "creativeFieldValueId": "A String", # ID of the creative field value.
+      },
+    ],
+    "backgroundColor": "A String", # 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.
+    "customKeyValues": [ # 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.
+      "A String",
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "htmlCode": "A String", # 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.
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+    "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+    "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+    "studioAdvertiserId": "A String", # 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.
+    "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+      { # Creative Asset.
+        "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "flashVersion": 42, # 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.
+        "pushdown": True or False, # 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.
+        "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "detectedFeatures": [ # 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.
+          "A String",
+        ],
+        "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+        "positionTopUnit": "A String", # 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.
+        "id": "A String", # 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.
+        "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+        "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "width": 42, # Width of this size.
+          "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+          "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+          "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+          "height": 42, # Height of this size.
+        },
+        "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+        "role": "A String", # 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.
+            # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+            # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+            # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+            # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+            # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+            # ALTERNATE_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.
+            # For 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.
+        "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "windowMode": "A String", # 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.
+        "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+        "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "fileSize": "A String", # 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.
+        "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+        "offset": { # Offset Position. # 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.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "active": True or False, # 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.
+        "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+        "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+        "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+        "zIndex": 42, # 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.
+        "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+        "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+        "actionScript3": True or False, # 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.
+        "pushdownDuration": 3.14, # 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.
+        "assetIdentifier": { # Creative Asset ID. # 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.
+          "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+          "name": "A String", # 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.
+        },
+        "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+        "sslCompliant": True or False, # 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.
+        "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "top": 42, # Offset distance from top side of an asset or a window.
+          "left": 42, # Offset distance from left side of an asset or a window.
+        },
+        "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+      },
+    ],
+    "redirectUrl": "A String", # 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
+    "videoDuration": 3.14, # 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.
+    "htmlCodeLocked": True or False, # 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.
+    "convertFlashToHtml5": True or False, # 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.
+    "clickTags": [ # 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.
+      { # Creative Click Tag.
+        "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+        "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+      },
+    ],
+    "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    "active": True or False, # Whether the creative is active. Applicable to all creative types.
+    "compatibility": [ # 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.
+        # 
+        # Acceptable values are:
+        # - "APP"
+        # - "APP_INTERSTITIAL"
+        # - "IN_STREAM_VIDEO"
+        # - "DISPLAY"
+        # - "DISPLAY_INTERSTITIAL"
+      "A String",
+    ],
+    "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+    "adTagKeys": [ # 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.
+      "A String",
+    ],
+    "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+    "subaccountId": "A String", # 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.
+    "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+    "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+    "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+    "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+    "studioCreativeId": "A String", # 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.
+    "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+    "allowScriptAccess": True or False, # 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.
+    "companionCreatives": [ # 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.
+      "A String",
+    ],
+    "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+    "backupImageFeatures": [ # 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.
+      "A String",
+    ],
+    "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "customHtml": "A String", # User-entered value.
+      "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+    },
+    "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Creative.
+      "thirdPartyUrls": [ # Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+        { # Third-party Tracking URL.
+          "url": "A String", # URL for the specified third-party URL type.
+          "thirdPartyUrlType": "A String", # Third-party URL type for in-stream video creatives.
+        },
+      ],
+      "artworkType": "A String", # 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.
+      "latestTraffickedCreativeId": "A String", # 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.
+      "videoDescription": "A String", # Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "advertiserId": "A String", # Advertiser ID of this creative. This is a required field. Applicable to all creative types.
+      "requiredFlashPluginVersion": "A String", # 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.
+      "thirdPartyBackupImageImpressionsUrl": "A String", # Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA
+      "timerCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the rendering ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "fsCommand": { # FsCommand. # 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.
+        "windowHeight": 42, # Height of the window.
+        "top": 42, # Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+        "windowWidth": 42, # Width of the window.
+        "positionOption": "A String", # Position in the browser where the window will open.
+        "left": 42, # Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER.
+      },
+      "id": "A String", # ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types.
+      "accountId": "A String", # 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.
+      "studioTraffickedCreativeId": "A String", # 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.
+      "archived": True or False, # Whether the creative is archived. Applicable to all creative types.
+      "overrideCss": "A String", # Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA.
+      "authoringSource": "A String", # Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types.
+      "requiredFlashVersion": 42, # 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.
+      "exitCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "renderingId": "A String", # ID of current rendering version. This is a read-only field. Applicable to all creative types.
+      "counterCustomEvents": [ # 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.
+        { # Creative Custom Event.
+          "targetType": "A String", # Target type used by the event.
+          "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+          "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+          "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+            "showStatusBar": True or False, # Whether to display the browser status bar.
+            "showScrollBar": True or False, # Whether to display the browser scroll bar.
+            "showAddressBar": True or False, # Whether to display the browser address bar.
+            "showMenuBar": True or False, # Whether to display the browser menu bar.
+            "title": "A String", # Title of popup window.
+            "showToolBar": True or False, # Whether to display the browser tool bar.
+            "positionType": "A String", # Popup window position either centered or at specific coordinate.
+            "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+              "top": 42, # Offset distance from top side of an asset or a window.
+              "left": 42, # Offset distance from left side of an asset or a window.
+            },
+            "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+              "width": 42, # Width of this size.
+              "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+              "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+              "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+              "height": 42, # Height of this size.
+            },
+          },
+          "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+          "artworkLabel": "A String", # 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.
+          "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+          "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+          "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+          "advertiserCustomEventName": "A String", # User-entered name for the event.
+        },
+      ],
+      "backupImageReportingLabel": "A String", # Reporting label used for HTML5 banner backup image. Applicable to the following creative types: ENHANCED_BANNER.
+      "version": 42, # 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.
+      "creativeFieldAssignments": [ # Creative field assignments for this creative. Applicable to all creative types.
+        { # Creative Field Assignment.
+          "creativeFieldId": "A String", # ID of the creative field.
+          "creativeFieldValueId": "A String", # ID of the creative field value.
+        },
+      ],
+      "backgroundColor": "A String", # 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.
+      "customKeyValues": [ # 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.
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this creative. This is a read-only field. Applicable to all creative types.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "htmlCode": "A String", # 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.
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "type": "A String", # Type of this creative.This is a required field. Applicable to all creative types.
+      "totalFileSize": "A String", # Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.
+      "thirdPartyRichMediaImpressionsUrl": "A String", # Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA
+      "studioAdvertiserId": "A String", # 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.
+      "creativeAssets": [ # Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT
+        { # Creative Asset.
+          "mimeType": "A String", # Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "artworkType": "A String", # Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "positionLeftUnit": "A String", # Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "collapsedSize": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "flashVersion": 42, # 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.
+          "pushdown": True or False, # 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.
+          "hideFlashObjects": True or False, # Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "detectedFeatures": [ # 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.
+            "A String",
+          ],
+          "duration": 42, # Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR.
+          "positionTopUnit": "A String", # 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.
+          "id": "A String", # 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.
+          "alignment": "A String", # Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING.
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # 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.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "horizontallyLocked": True or False, # Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "startTimeType": "A String", # Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+          "displayType": "A String", # Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "expandedDimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "verticallyLocked": True or False, # Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
+          "role": "A String", # 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.
+              # PRIMARY applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives.
+              # BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives.
+              # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives.
+              # OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives.
+              # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives.
+              # ALTERNATE_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.
+              # For 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.
+          "zipFilesize": "A String", # Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "bitRate": 42, # Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "windowMode": "A String", # 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.
+          "progressiveServingUrl": "A String", # Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "durationType": "A String", # Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
+          "videoDuration": 3.14, # Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "fileSize": "A String", # 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.
+          "zipFilename": "A String", # File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+          "offset": { # Offset Position. # 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.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "active": True or False, # 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.
+          "originalBackup": True or False, # Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
+          "hideSelectionBoxes": True or False, # Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
+          "streamingServingUrl": "A String", # Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
+          "zIndex": 42, # 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.
+          "childAssetType": "A String", # Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
+          "backupImageExit": { # Creative Custom Event. # Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
+            "targetType": "A String", # Target type used by the event.
+            "artworkType": "A String", # Artwork type used by the creative.This is a read-only field.
+            "videoReportingId": "A String", # Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field.
+            "popupWindowProperties": { # Popup Window Properties. # Properties for rich media popup windows. This field is used only for exit events.
+              "showStatusBar": True or False, # Whether to display the browser status bar.
+              "showScrollBar": True or False, # Whether to display the browser scroll bar.
+              "showAddressBar": True or False, # Whether to display the browser address bar.
+              "showMenuBar": True or False, # Whether to display the browser menu bar.
+              "title": "A String", # Title of popup window.
+              "showToolBar": True or False, # Whether to display the browser tool bar.
+              "positionType": "A String", # Popup window position either centered or at specific coordinate.
+              "offset": { # Offset Position. # Upper-left corner coordinates of the popup window. Applicable if positionType is COORDINATES.
+                "top": 42, # Offset distance from top side of an asset or a window.
+                "left": 42, # Offset distance from left side of an asset or a window.
+              },
+              "dimension": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Popup dimension for a creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID
+                "width": 42, # Width of this size.
+                "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+                "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+                "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+                "height": 42, # Height of this size.
+              },
+            },
+            "advertiserCustomEventId": "A String", # Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field.
+            "artworkLabel": "A String", # 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.
+            "advertiserCustomEventType": "A String", # Type of the event. This is a read-only field.
+            "exitUrl": "A String", # Exit URL of the event. This field is used only for exit events.
+            "id": "A String", # ID of this event. This is a required field and should not be modified after insertion.
+            "advertiserCustomEventName": "A String", # User-entered name for the event.
+          },
+          "actionScript3": True or False, # 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.
+          "pushdownDuration": 3.14, # 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.
+          "assetIdentifier": { # Creative Asset ID. # 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.
+            "type": "A String", # Type of asset to upload. This is a required field. IMAGE is solely used for IMAGE creatives. Other image assets should use HTML_IMAGE.
+            "name": "A String", # 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.
+          },
+          "transparency": True or False, # Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
+          "sslCompliant": True or False, # 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.
+          "position": { # Offset Position. # Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
+            "top": 42, # Offset distance from top side of an asset or a window.
+            "left": 42, # Offset distance from left side of an asset or a window.
+          },
+          "customStartTimeValue": 42, # Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
+        },
+      ],
+      "redirectUrl": "A String", # 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
+      "videoDuration": 3.14, # 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.
+      "htmlCodeLocked": True or False, # 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.
+      "convertFlashToHtml5": True or False, # 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.
+      "clickTags": [ # 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.
+        { # Creative Click Tag.
+          "eventName": "A String", # Advertiser event name associated with the click tag. This field is used by ENHANCED_BANNER, ENHANCED_IMAGE, and HTML5_BANNER creatives.
+          "name": "A String", # 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": "A String", # Parameter value for the specified click tag. This field contains a click-through url.
+        },
+      ],
+      "commercialId": "A String", # Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+      "active": True or False, # Whether the creative is active. Applicable to all creative types.
+      "compatibility": [ # 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.
+          #
+          # Acceptable values are:
+          # - "APP"
+          # - "APP_INTERSTITIAL"
+          # - "IN_STREAM_VIDEO"
+          # - "DISPLAY"
+          # - "DISPLAY_INTERSTITIAL"
+        "A String",
+      ],
+      "adParameters": "A String", # Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID.
+      "adTagKeys": [ # 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.
+        "A String",
+      ],
+      "kind": "dfareporting#creative", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative".
+      "subaccountId": "A String", # 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.
+      "name": "A String", # Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types.
+      "sslOverride": True or False, # Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types.
+      "lastModifiedInfo": { # Modification timestamp. # Creative last modification information. This is a read-only field. Applicable to all creative types.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "backupImageClickThroughUrl": "A String", # Click-through URL for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+      "sslCompliant": True or False, # Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.
+      "studioCreativeId": "A String", # 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.
+      "authoringTool": "A String", # Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
+      "allowScriptAccess": True or False, # 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.
+      "companionCreatives": [ # 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.
+        "A String",
+      ],
+      "auto_advance_images": True or False, # Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE.
+      "backupImageFeatures": [ # 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.
+        "A String",
+      ],
+      "backupImageTargetWindow": { # Target Window. # Target window for backup image. Applicable to the following creative types: ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
+        "customHtml": "A String", # User-entered value.
+        "targetWindowOption": "A String", # Type of browser window for which the backup image of the flash creative can be displayed.
+      },
+      "skippable": True or False, # Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.dimensionValues.html b/docs/dyn/dfareporting_v2_4.dimensionValues.html new file mode 100644 index 00000000000..f8d1faf55dd --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.dimensionValues.html @@ -0,0 +1,144 @@ + + + +

DCM/DFA Reporting And Trafficking API . dimensionValues

+

Instance Methods

+

+ query(profileId, body, pageToken=None, maxResults=None)

+

Retrieves list of report dimension values for a list of filters.

+

+ query_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ query(profileId, body, pageToken=None, maxResults=None) +
Retrieves list of report dimension values for a list of filters.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a DimensionValuesRequest.
+    "dimensionName": "A String", # The name of the dimension for which values should be requested.
+    "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
+    "kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
+    "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
+    "filters": [ # The list of filters by which to filter values. The filters are ANDed.
+      { # Represents a dimension filter.
+        "dimensionName": "A String", # The name of the dimension to filter.
+        "kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
+        "value": "A String", # The value of the dimension to filter.
+      },
+    ],
+  }
+
+  pageToken: string, The value of the nextToken from the previous result page.
+  maxResults: integer, Maximum number of results to return.
+
+Returns:
+  An object of the form:
+
+    { # Represents the list of DimensionValue resources.
+    "nextPageToken": "A String", # 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.
+    "items": [ # The dimension values returned in this response.
+      { # Represents a DimensionValue resource.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+    ],
+    "kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
+    "etag": "A String", # The eTag of this response for caching purposes.
+  }
+
+ +
+ query_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.directorySiteContacts.html b/docs/dyn/dfareporting_v2_4.directorySiteContacts.html new file mode 100644 index 00000000000..8f9331ff161 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.directorySiteContacts.html @@ -0,0 +1,169 @@ + + + +

DCM/DFA Reporting And Trafficking API . directorySiteContacts

+

Instance Methods

+

+ get(profileId, id)

+

Gets one directory site contact by ID.

+

+ list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of directory site contacts, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, id) +
Gets one directory site contact by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Directory site contact ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Site Directory contact.
+    "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
+    "firstName": "A String", # First name of this directory site contact.
+    "title": "A String", # Title or designation of this directory site contact.
+    "lastName": "A String", # Last name of this directory site contact.
+    "email": "A String", # Email address of this directory site contact.
+    "phone": "A String", # Phone number of this directory site contact.
+    "role": "A String", # Directory site contact role.
+    "address": "A String", # Address of this directory site contact.
+    "type": "A String", # Directory site contact type.
+    "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+  }
+
+ +
+ list(profileId, searchString=None, directorySiteIds=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of directory site contacts, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  directorySiteIds: string, Select only directory site contacts with these directory site IDs. This is a required field. (repeated)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only directory site contacts with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Directory Site Contact List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "directorySiteContacts": [ # Directory site contact collection
+      { # Contains properties of a Site Directory contact.
+        "kind": "dfareporting#directorySiteContact", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContact".
+        "firstName": "A String", # First name of this directory site contact.
+        "title": "A String", # Title or designation of this directory site contact.
+        "lastName": "A String", # Last name of this directory site contact.
+        "email": "A String", # Email address of this directory site contact.
+        "phone": "A String", # Phone number of this directory site contact.
+        "role": "A String", # Directory site contact role.
+        "address": "A String", # Address of this directory site contact.
+        "type": "A String", # Directory site contact type.
+        "id": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+      },
+    ],
+    "kind": "dfareporting#directorySiteContactsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySiteContactsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.directorySites.html b/docs/dyn/dfareporting_v2_4.directorySites.html new file mode 100644 index 00000000000..fa3f7ac3ed9 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.directorySites.html @@ -0,0 +1,590 @@ + + + +

DCM/DFA Reporting And Trafficking API . directorySites

+

Instance Methods

+

+ get(profileId, id)

+

Gets one directory site by ID.

+

+ insert(profileId, body)

+

Inserts a new directory site.

+

+ list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None)

+

Retrieves a list of directory sites, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, id) +
Gets one directory site by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Directory site ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+      "countryId": "A String", # Country ID of this directory site.
+      "description": "A String", # Description of this directory site.
+      "settings": { # Directory Site Settings # Directory site settings.
+        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
+        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+        "dfp_settings": { # DFP Settings # Directory site DFP settings.
+          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
+          "dfp_network_name": "A String", # DFP network name for this directory site.
+          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+          "dfp_network_code": "A String", # DFP network code for this directory site.
+        },
+        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
+        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
+        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
+      },
+      "currencyId": "A String", # Currency ID of this directory site.
+          # Possible values are:
+          # - "1" for USD
+          # - "2" for GBP
+          # - "3" for ESP
+          # - "4" for SEK
+          # - "5" for CAD
+          # - "6" for JPY
+          # - "7" for DEM
+          # - "8" for AUD
+          # - "9" for FRF
+          # - "10" for ITL
+          # - "11" for DKK
+          # - "12" for NOK
+          # - "13" for FIM
+          # - "14" for ZAR
+          # - "15" for IEP
+          # - "16" for NLG
+          # - "17" for EUR
+          # - "18" for KRW
+          # - "19" for TWD
+          # - "20" for SGD
+          # - "21" for CNY
+          # - "22" for HKD
+          # - "23" for NZD
+          # - "24" for MYR
+          # - "25" for BRL
+          # - "26" for PTE
+          # - "27" for MXP
+          # - "28" for CLP
+          # - "29" for TRY
+          # - "30" for ARS
+          # - "31" for PEN
+          # - "32" for ILS
+          # - "33" for CHF
+          # - "34" for VEF
+          # - "35" for COP
+          # - "36" for GTQ
+          # - "37" for PLN
+          # - "39" for INR
+          # - "40" for THB
+          # - "41" for IDR
+          # - "42" for CZK
+          # - "43" for RON
+          # - "44" for HUF
+          # - "45" for RUB
+          # - "46" for AED
+          # - "47" for BGN
+          # - "48" for HRK
+      "inpageTagFormats": [ # Tag types for regular placements.
+          #
+          # Acceptable values are:
+          # - "STANDARD"
+          # - "IFRAME_JAVASCRIPT_INPAGE"
+          # - "INTERNAL_REDIRECT_INPAGE"
+          # - "JAVASCRIPT_INPAGE"
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "interstitialTagFormats": [ # Tag types for interstitial placements.
+          #
+          # Acceptable values are:
+          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
+          # - "INTERNAL_REDIRECT_INTERSTITIAL"
+          # - "JAVASCRIPT_INTERSTITIAL"
+        "A String",
+      ],
+      "contactAssignments": [ # Directory site contacts.
+        { # Directory Site Contact Assignment
+          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+          "visibility": "A String", # 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.
+        },
+      ],
+      "url": "A String", # URL of this directory site.
+      "parentId": "A String", # Parent directory site ID.
+      "active": True or False, # Whether this directory site is active.
+      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+      "name": "A String", # Name of this directory site.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new directory site.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+    "countryId": "A String", # Country ID of this directory site.
+    "description": "A String", # Description of this directory site.
+    "settings": { # Directory Site Settings # Directory site settings.
+      "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
+      "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+      "dfp_settings": { # DFP Settings # Directory site DFP settings.
+        "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
+        "dfp_network_name": "A String", # DFP network name for this directory site.
+        "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+        "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+        "dfp_network_code": "A String", # DFP network code for this directory site.
+      },
+      "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
+      "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
+      "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+      "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
+    },
+    "currencyId": "A String", # Currency ID of this directory site.
+        # Possible values are:
+        # - "1" for USD
+        # - "2" for GBP
+        # - "3" for ESP
+        # - "4" for SEK
+        # - "5" for CAD
+        # - "6" for JPY
+        # - "7" for DEM
+        # - "8" for AUD
+        # - "9" for FRF
+        # - "10" for ITL
+        # - "11" for DKK
+        # - "12" for NOK
+        # - "13" for FIM
+        # - "14" for ZAR
+        # - "15" for IEP
+        # - "16" for NLG
+        # - "17" for EUR
+        # - "18" for KRW
+        # - "19" for TWD
+        # - "20" for SGD
+        # - "21" for CNY
+        # - "22" for HKD
+        # - "23" for NZD
+        # - "24" for MYR
+        # - "25" for BRL
+        # - "26" for PTE
+        # - "27" for MXP
+        # - "28" for CLP
+        # - "29" for TRY
+        # - "30" for ARS
+        # - "31" for PEN
+        # - "32" for ILS
+        # - "33" for CHF
+        # - "34" for VEF
+        # - "35" for COP
+        # - "36" for GTQ
+        # - "37" for PLN
+        # - "39" for INR
+        # - "40" for THB
+        # - "41" for IDR
+        # - "42" for CZK
+        # - "43" for RON
+        # - "44" for HUF
+        # - "45" for RUB
+        # - "46" for AED
+        # - "47" for BGN
+        # - "48" for HRK
+    "inpageTagFormats": [ # Tag types for regular placements.
+        # 
+        # Acceptable values are:
+        # - "STANDARD"
+        # - "IFRAME_JAVASCRIPT_INPAGE"
+        # - "INTERNAL_REDIRECT_INPAGE"
+        # - "JAVASCRIPT_INPAGE"
+      "A String",
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "interstitialTagFormats": [ # Tag types for interstitial placements.
+        # 
+        # Acceptable values are:
+        # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
+        # - "INTERNAL_REDIRECT_INTERSTITIAL"
+        # - "JAVASCRIPT_INTERSTITIAL"
+      "A String",
+    ],
+    "contactAssignments": [ # Directory site contacts.
+      { # Directory Site Contact Assignment
+        "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+        "visibility": "A String", # 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.
+      },
+    ],
+    "url": "A String", # URL of this directory site.
+    "parentId": "A String", # Parent directory site ID.
+    "active": True or False, # Whether this directory site is active.
+    "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+    "name": "A String", # Name of this directory site.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+      "countryId": "A String", # Country ID of this directory site.
+      "description": "A String", # Description of this directory site.
+      "settings": { # Directory Site Settings # Directory site settings.
+        "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
+        "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+        "dfp_settings": { # DFP Settings # Directory site DFP settings.
+          "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
+          "dfp_network_name": "A String", # DFP network name for this directory site.
+          "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+          "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+          "dfp_network_code": "A String", # DFP network code for this directory site.
+        },
+        "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
+        "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
+        "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+        "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
+      },
+      "currencyId": "A String", # Currency ID of this directory site.
+          # Possible values are:
+          # - "1" for USD
+          # - "2" for GBP
+          # - "3" for ESP
+          # - "4" for SEK
+          # - "5" for CAD
+          # - "6" for JPY
+          # - "7" for DEM
+          # - "8" for AUD
+          # - "9" for FRF
+          # - "10" for ITL
+          # - "11" for DKK
+          # - "12" for NOK
+          # - "13" for FIM
+          # - "14" for ZAR
+          # - "15" for IEP
+          # - "16" for NLG
+          # - "17" for EUR
+          # - "18" for KRW
+          # - "19" for TWD
+          # - "20" for SGD
+          # - "21" for CNY
+          # - "22" for HKD
+          # - "23" for NZD
+          # - "24" for MYR
+          # - "25" for BRL
+          # - "26" for PTE
+          # - "27" for MXP
+          # - "28" for CLP
+          # - "29" for TRY
+          # - "30" for ARS
+          # - "31" for PEN
+          # - "32" for ILS
+          # - "33" for CHF
+          # - "34" for VEF
+          # - "35" for COP
+          # - "36" for GTQ
+          # - "37" for PLN
+          # - "39" for INR
+          # - "40" for THB
+          # - "41" for IDR
+          # - "42" for CZK
+          # - "43" for RON
+          # - "44" for HUF
+          # - "45" for RUB
+          # - "46" for AED
+          # - "47" for BGN
+          # - "48" for HRK
+      "inpageTagFormats": [ # Tag types for regular placements.
+          #
+          # Acceptable values are:
+          # - "STANDARD"
+          # - "IFRAME_JAVASCRIPT_INPAGE"
+          # - "INTERNAL_REDIRECT_INPAGE"
+          # - "JAVASCRIPT_INPAGE"
+        "A String",
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "interstitialTagFormats": [ # Tag types for interstitial placements.
+          #
+          # Acceptable values are:
+          # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
+          # - "INTERNAL_REDIRECT_INTERSTITIAL"
+          # - "JAVASCRIPT_INTERSTITIAL"
+        "A String",
+      ],
+      "contactAssignments": [ # Directory site contacts.
+        { # Directory Site Contact Assignment
+          "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+          "visibility": "A String", # 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.
+        },
+      ],
+      "url": "A String", # URL of this directory site.
+      "parentId": "A String", # Parent directory site ID.
+      "active": True or False, # Whether this directory site is active.
+      "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+      "name": "A String", # Name of this directory site.
+    }
+
+ +
+ list(profileId, countryId=None, acceptsInStreamVideoPlacements=None, pageToken=None, sortOrder=None, parentId=None, acceptsPublisherPaidPlacements=None, acceptsInterstitialPlacements=None, maxResults=None, active=None, searchString=None, sortField=None, ids=None, dfp_network_code=None) +
Retrieves a list of directory sites, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  countryId: string, Select only directory sites with this country ID.
+  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  parentId: string, Select only directory sites with this parent ID.
+  acceptsPublisherPaidPlacements: boolean, Select only directory sites that accept publisher paid placements. This field can be left blank.
+  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+  maxResults: integer, Maximum number of results to return.
+  active: boolean, Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
+  searchString: string, 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".
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only directory sites with these IDs. (repeated)
+  dfp_network_code: string, Select only directory sites with this DFP network code.
+
+Returns:
+  An object of the form:
+
+    { # Directory Site List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#directorySitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySitesListResponse".
+    "directorySites": [ # Directory site collection.
+      { # 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.
+          "kind": "dfareporting#directorySite", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#directorySite".
+          "countryId": "A String", # Country ID of this directory site.
+          "description": "A String", # Description of this directory site.
+          "settings": { # Directory Site Settings # Directory site settings.
+            "nielsenOcrOptOut": True or False, # Whether this directory site has disabled Nielsen OCR reach ratings.
+            "activeViewOptOut": True or False, # Whether this directory site has disabled active view creatives.
+            "dfp_settings": { # DFP Settings # Directory site DFP settings.
+              "publisherPortalOnly": True or False, # Whether this directory site is available only via DoubleClick Publisher Portal.
+              "dfp_network_name": "A String", # DFP network name for this directory site.
+              "pubPaidPlacementAccepted": True or False, # Whether this directory site accepts publisher-paid tags.
+              "programmaticPlacementAccepted": True or False, # Whether this directory site accepts programmatic placements.
+              "dfp_network_code": "A String", # DFP network code for this directory site.
+            },
+            "verificationTagOptOut": True or False, # Whether this directory site has disabled generation of Verification ins tags.
+            "instream_video_placement_accepted": True or False, # Whether this site accepts in-stream video ads.
+            "interstitialPlacementAccepted": True or False, # Whether this site accepts interstitial ads.
+            "videoActiveViewOptOut": True or False, # Whether this directory site has disabled active view for in-stream video creatives.
+          },
+          "currencyId": "A String", # Currency ID of this directory site.
+              # Possible values are:
+              # - "1" for USD
+              # - "2" for GBP
+              # - "3" for ESP
+              # - "4" for SEK
+              # - "5" for CAD
+              # - "6" for JPY
+              # - "7" for DEM
+              # - "8" for AUD
+              # - "9" for FRF
+              # - "10" for ITL
+              # - "11" for DKK
+              # - "12" for NOK
+              # - "13" for FIM
+              # - "14" for ZAR
+              # - "15" for IEP
+              # - "16" for NLG
+              # - "17" for EUR
+              # - "18" for KRW
+              # - "19" for TWD
+              # - "20" for SGD
+              # - "21" for CNY
+              # - "22" for HKD
+              # - "23" for NZD
+              # - "24" for MYR
+              # - "25" for BRL
+              # - "26" for PTE
+              # - "27" for MXP
+              # - "28" for CLP
+              # - "29" for TRY
+              # - "30" for ARS
+              # - "31" for PEN
+              # - "32" for ILS
+              # - "33" for CHF
+              # - "34" for VEF
+              # - "35" for COP
+              # - "36" for GTQ
+              # - "37" for PLN
+              # - "39" for INR
+              # - "40" for THB
+              # - "41" for IDR
+              # - "42" for CZK
+              # - "43" for RON
+              # - "44" for HUF
+              # - "45" for RUB
+              # - "46" for AED
+              # - "47" for BGN
+              # - "48" for HRK
+          "inpageTagFormats": [ # Tag types for regular placements.
+              #
+              # Acceptable values are:
+              # - "STANDARD"
+              # - "IFRAME_JAVASCRIPT_INPAGE"
+              # - "INTERNAL_REDIRECT_INPAGE"
+              # - "JAVASCRIPT_INPAGE"
+            "A String",
+          ],
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this directory site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "interstitialTagFormats": [ # Tag types for interstitial placements.
+              #
+              # Acceptable values are:
+              # - "IFRAME_JAVASCRIPT_INTERSTITIAL"
+              # - "INTERNAL_REDIRECT_INTERSTITIAL"
+              # - "JAVASCRIPT_INTERSTITIAL"
+            "A String",
+          ],
+          "contactAssignments": [ # Directory site contacts.
+            { # Directory Site Contact Assignment
+              "contactId": "A String", # ID of this directory site contact. This is a read-only, auto-generated field.
+              "visibility": "A String", # 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.
+            },
+          ],
+          "url": "A String", # URL of this directory site.
+          "parentId": "A String", # Parent directory site ID.
+          "active": True or False, # Whether this directory site is active.
+          "id": "A String", # ID of this directory site. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this directory site.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.eventTags.html b/docs/dyn/dfareporting_v2_4.eventTags.html new file mode 100644 index 00000000000..213c87a52fa --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.eventTags.html @@ -0,0 +1,493 @@ + + + +

DCM/DFA Reporting And Trafficking API . eventTags

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing event tag.

+

+ get(profileId, id)

+

Gets one event tag by ID.

+

+ insert(profileId, body)

+

Inserts a new event tag.

+

+ list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None)

+

Retrieves a list of event tags, possibly filtered.

+

+ patch(profileId, id, body)

+

Updates an existing event tag. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing event tag.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing event tag.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Event tag ID. (required)
+
+
+ +
+ get(profileId, id) +
Gets one event tag by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Event tag ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of an event tag.
+      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+      "url": "A String", # 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.
+      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+      "urlEscapeLevels": 42, # 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.
+      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+        "A String",
+      ],
+      "excludeFromAdxRequests": True or False, # 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.
+      "type": "A String", # 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.
+      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new event tag.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of an event tag.
+    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+    "url": "A String", # 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.
+    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+    "urlEscapeLevels": 42, # 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.
+    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+      "A String",
+    ],
+    "excludeFromAdxRequests": True or False, # 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.
+    "type": "A String", # 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.
+    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of an event tag.
+      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+      "url": "A String", # 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.
+      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+      "urlEscapeLevels": 42, # 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.
+      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+        "A String",
+      ],
+      "excludeFromAdxRequests": True or False, # 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.
+      "type": "A String", # 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.
+      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, campaignId=None, advertiserId=None, adId=None, sortOrder=None, definitionsOnly=None, eventTagTypes=None, searchString=None, sortField=None, enabled=None, ids=None) +
Retrieves a list of event tags, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Select only event tags that belong to this campaign.
+  advertiserId: string, Select only event tags that belong to this advertiser.
+  adId: string, Select only event tags that belong to this ad.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  definitionsOnly: boolean, 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.
+  eventTagTypes: string, 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. (repeated)
+    Allowed values
+      CLICK_THROUGH_EVENT_TAG - 
+      IMPRESSION_IMAGE_EVENT_TAG - 
+      IMPRESSION_JAVASCRIPT_EVENT_TAG - 
+  searchString: string, 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".
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  enabled: boolean, 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.
+  ids: string, Select only event tags with these IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Event Tag List Response
+    "eventTags": [ # Event tag collection.
+      { # Contains properties of an event tag.
+          "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+          "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+          "url": "A String", # 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.
+          "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+          "urlEscapeLevels": 42, # 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.
+          "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+          "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+          "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+          "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+            "A String",
+          ],
+          "excludeFromAdxRequests": True or False, # 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.
+          "type": "A String", # 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.
+          "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#eventTagsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTagsListResponse".
+  }
+
+ +
+ patch(profileId, id, body) +
Updates an existing event tag. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Event tag ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of an event tag.
+    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+    "url": "A String", # 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.
+    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+    "urlEscapeLevels": 42, # 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.
+    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+      "A String",
+    ],
+    "excludeFromAdxRequests": True or False, # 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.
+    "type": "A String", # 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.
+    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of an event tag.
+      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+      "url": "A String", # 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.
+      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+      "urlEscapeLevels": 42, # 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.
+      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+        "A String",
+      ],
+      "excludeFromAdxRequests": True or False, # 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.
+      "type": "A String", # 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.
+      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing event tag.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of an event tag.
+    "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+    "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+    "url": "A String", # 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.
+    "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+    "urlEscapeLevels": 42, # 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.
+    "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+    "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+    "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+    "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+      "A String",
+    ],
+    "excludeFromAdxRequests": True or False, # 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.
+    "type": "A String", # 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.
+    "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of an event tag.
+      "status": "A String", # Status of this event tag. Must be ENABLED for this event tag to fire. This is a required field.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "subaccountId": "A String", # Subaccount ID of this event tag. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this event tag. This is a required field and must be less than 256 characters long.
+      "campaignId": "A String", # Campaign ID of this event tag. This field or the advertiserId field is required on insertion.
+      "url": "A String", # 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.
+      "sslCompliant": True or False, # Whether this tag is SSL-compliant or not. This is a read-only field.
+      "urlEscapeLevels": 42, # 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.
+      "kind": "dfareporting#eventTag", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#eventTag".
+      "enabledByDefault": True or False, # Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.
+      "advertiserId": "A String", # Advertiser ID of this event tag. This field or the campaignId field is required on insertion.
+      "siteFilterType": "A String", # Site filter type for this event tag. If no type is specified then the event tag will be applied to all sites.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteIds": [ # Filter list of site IDs associated with this event tag. The siteFilterType determines whether this is a whitelist or blacklist filter.
+        "A String",
+      ],
+      "excludeFromAdxRequests": True or False, # 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.
+      "type": "A String", # 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.
+      "id": "A String", # ID of this event tag. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this event tag. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.files.html b/docs/dyn/dfareporting_v2_4.files.html new file mode 100644 index 00000000000..99bf5d8d41f --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.files.html @@ -0,0 +1,205 @@ + + + +

DCM/DFA Reporting And Trafficking API . files

+

Instance Methods

+

+ get(reportId, fileId)

+

Retrieves a report file by its report ID and file ID.

+

+ get_media(reportId, fileId)

+

Retrieves a report file by its report ID and file ID.

+

+ list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)

+

Lists files for a user profile.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(reportId, fileId) +
Retrieves a report file by its report ID and file ID.
+
+Args:
+  reportId: string, The ID of the report. (required)
+  fileId: string, The ID of the report file. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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".
+    "status": "A String", # The status of the report file.
+    "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+    "format": "A String", # The output format of the report. Only available once the file is available.
+    "dateRange": { # Represents a date range. # 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.
+      "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+      "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+    },
+    "fileName": "A String", # The filename of the file.
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "reportId": "A String", # The ID of the report this file was generated from.
+    "urls": { # The URLs where the completed report file can be downloaded.
+      "browserUrl": "A String", # The URL for downloading the report data through a browser.
+      "apiUrl": "A String", # The URL for downloading the report data through the API.
+    },
+    "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+    "id": "A String", # The unique ID of this report file.
+  }
+
+ +
+ get_media(reportId, fileId) +
Retrieves a report file by its report ID and file ID.
+
+Args:
+  reportId: string, The ID of the report. (required)
+  fileId: string, The ID of the report file. (required)
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None) +
Lists files for a user profile.
+
+Args:
+  profileId: string, The DFA profile ID. (required)
+  pageToken: string, The value of the nextToken from the previous result page.
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is 'DESCENDING'.
+    Allowed values
+      ASCENDING - Ascending order.
+      DESCENDING - Descending order.
+  sortField: string, The field by which to sort the list.
+    Allowed values
+      ID - Sort by file ID.
+      LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
+  scope: string, The scope that defines which results are returned, default is 'MINE'.
+    Allowed values
+      ALL - All files in account.
+      MINE - My files.
+      SHARED_WITH_ME - Files shared with me.
+
+Returns:
+  An object of the form:
+
+    { # Represents the list of File resources.
+    "nextPageToken": "A String", # 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.
+    "items": [ # The files returned in this response.
+      { # 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".
+        "status": "A String", # The status of the report file.
+        "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+        "format": "A String", # The output format of the report. Only available once the file is available.
+        "dateRange": { # Represents a date range. # 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.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "fileName": "A String", # The filename of the file.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "reportId": "A String", # The ID of the report this file was generated from.
+        "urls": { # The URLs where the completed report file can be downloaded.
+          "browserUrl": "A String", # The URL for downloading the report data through a browser.
+          "apiUrl": "A String", # The URL for downloading the report data through the API.
+        },
+        "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+        "id": "A String", # The unique ID of this report file.
+      },
+    ],
+    "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
+    "etag": "A String", # The eTag of this response for caching purposes.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.floodlightActivities.html b/docs/dyn/dfareporting_v2_4.floodlightActivities.html new file mode 100644 index 00000000000..ad4e347071b --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.floodlightActivities.html @@ -0,0 +1,1045 @@ + + + +

DCM/DFA Reporting And Trafficking API . floodlightActivities

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing floodlight activity.

+

+ generatetag(profileId, floodlightActivityId=None)

+

Generates a tag for a floodlight activity.

+

+ get(profileId, id)

+

Gets one floodlight activity by ID.

+

+ insert(profileId, body)

+

Inserts a new floodlight activity.

+

+ list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)

+

Retrieves a list of floodlight activities, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing floodlight activity. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing floodlight activity.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing floodlight activity.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight activity ID. (required)
+
+
+ +
+ generatetag(profileId, floodlightActivityId=None) +
Generates a tag for a floodlight activity.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag.
+
+Returns:
+  An object of the form:
+
+    { # Floodlight Activity GenerateTag Response
+    "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse".
+    "floodlightActivityTag": "A String", # Generated tag for this floodlight activity.
+  }
+
+ +
+ get(profileId, id) +
Gets one floodlight activity by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight activity ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity.
+      "tagString": "A String", # 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.
+      "secure": True or False, # Whether this tag should use SSL.
+      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+      "advertiserId": "A String", # 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.
+      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+      "publisherTags": [ # Publisher dynamic floodlight tags.
+        { # Publisher Dynamic Tag
+          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+          "siteId": "A String", # Site ID of this dynamic tag.
+          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+            "tag": "A String", # Tag code.
+            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this tag.
+          },
+          "directorySiteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "hidden": True or False, # Whether this activity is archived.
+      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+      "notes": "A String", # General notes or implementation instructions for the tag.
+      "floodlightConfigurationId": "A String", # 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.
+      "userDefinedVariableTypes": [ # 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.
+          # Acceptable values are:
+          # - "U1"
+          # - "U2"
+          # - "U3"
+          # - "U4"
+          # - "U5"
+          # - "U6"
+          # - "U7"
+          # - "U8"
+          # - "U9"
+          # - "U10"
+          # - "U11"
+          # - "U12"
+          # - "U13"
+          # - "U14"
+          # - "U15"
+          # - "U16"
+          # - "U17"
+          # - "U18"
+          # - "U19"
+          # - "U20"
+        "A String",
+      ],
+      "defaultTags": [ # Dynamic floodlight tags.
+        { # Dynamic Tag
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+      ],
+      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new floodlight activity.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+    "tagString": "A String", # 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.
+    "secure": True or False, # Whether this tag should use SSL.
+    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+    "advertiserId": "A String", # 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.
+    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+    "publisherTags": [ # Publisher dynamic floodlight tags.
+      { # Publisher Dynamic Tag
+        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+        "siteId": "A String", # Site ID of this dynamic tag.
+        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+        "directorySiteId": "A String", # 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.
+        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      },
+    ],
+    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "hidden": True or False, # Whether this activity is archived.
+    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+    "notes": "A String", # General notes or implementation instructions for the tag.
+    "floodlightConfigurationId": "A String", # 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.
+    "userDefinedVariableTypes": [ # 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.
+        # Acceptable values are:
+        # - "U1"
+        # - "U2"
+        # - "U3"
+        # - "U4"
+        # - "U5"
+        # - "U6"
+        # - "U7"
+        # - "U8"
+        # - "U9"
+        # - "U10"
+        # - "U11"
+        # - "U12"
+        # - "U13"
+        # - "U14"
+        # - "U15"
+        # - "U16"
+        # - "U17"
+        # - "U18"
+        # - "U19"
+        # - "U20"
+      "A String",
+    ],
+    "defaultTags": [ # Dynamic floodlight tags.
+      { # Dynamic Tag
+        "tag": "A String", # Tag code.
+        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this tag.
+      },
+    ],
+    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity.
+      "tagString": "A String", # 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.
+      "secure": True or False, # Whether this tag should use SSL.
+      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+      "advertiserId": "A String", # 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.
+      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+      "publisherTags": [ # Publisher dynamic floodlight tags.
+        { # Publisher Dynamic Tag
+          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+          "siteId": "A String", # Site ID of this dynamic tag.
+          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+            "tag": "A String", # Tag code.
+            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this tag.
+          },
+          "directorySiteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "hidden": True or False, # Whether this activity is archived.
+      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+      "notes": "A String", # General notes or implementation instructions for the tag.
+      "floodlightConfigurationId": "A String", # 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.
+      "userDefinedVariableTypes": [ # 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.
+          # Acceptable values are:
+          # - "U1"
+          # - "U2"
+          # - "U3"
+          # - "U4"
+          # - "U5"
+          # - "U6"
+          # - "U7"
+          # - "U8"
+          # - "U9"
+          # - "U10"
+          # - "U11"
+          # - "U12"
+          # - "U13"
+          # - "U14"
+          # - "U15"
+          # - "U16"
+          # - "U17"
+          # - "U18"
+          # - "U19"
+          # - "U20"
+        "A String",
+      ],
+      "defaultTags": [ # Dynamic floodlight tags.
+        { # Dynamic Tag
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+      ],
+      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+    }
+
+ +
+ list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None) +
Retrieves a list of floodlight activities, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name.
+  advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
+  tagString: string, Select only floodlight activities with the specified tag string.
+  floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string.
+  floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  maxResults: integer, Maximum number of results to return.
+  searchString: string, 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".
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
+  ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated)
+  floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type.
+    Allowed values
+      COUNTER - 
+      SALE - 
+
+Returns:
+  An object of the form:
+
+    { # Floodlight Activity List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse".
+    "floodlightActivities": [ # Floodlight activity collection.
+      { # Contains properties of a Floodlight activity.
+          "tagString": "A String", # 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.
+          "secure": True or False, # Whether this tag should use SSL.
+          "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+          "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+          "advertiserId": "A String", # 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.
+          "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+          "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+          "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+          "publisherTags": [ # Publisher dynamic floodlight tags.
+            { # Publisher Dynamic Tag
+              "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+              "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+              "siteId": "A String", # Site ID of this dynamic tag.
+              "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+                "tag": "A String", # Tag code.
+                "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+                "name": "A String", # Name of this tag.
+              },
+              "directorySiteId": "A String", # 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.
+              "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            },
+          ],
+          "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "hidden": True or False, # Whether this activity is archived.
+          "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+          "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+          "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+          "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+          "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+          "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+          "notes": "A String", # General notes or implementation instructions for the tag.
+          "floodlightConfigurationId": "A String", # 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.
+          "userDefinedVariableTypes": [ # 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.
+              # Acceptable values are:
+              # - "U1"
+              # - "U2"
+              # - "U3"
+              # - "U4"
+              # - "U5"
+              # - "U6"
+              # - "U7"
+              # - "U8"
+              # - "U9"
+              # - "U10"
+              # - "U11"
+              # - "U12"
+              # - "U13"
+              # - "U14"
+              # - "U15"
+              # - "U16"
+              # - "U17"
+              # - "U18"
+              # - "U19"
+              # - "U20"
+            "A String",
+          ],
+          "defaultTags": [ # Dynamic floodlight tags.
+            { # Dynamic Tag
+              "tag": "A String", # Tag code.
+              "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+              "name": "A String", # Name of this tag.
+            },
+          ],
+          "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+          "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing floodlight activity. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight activity ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+    "tagString": "A String", # 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.
+    "secure": True or False, # Whether this tag should use SSL.
+    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+    "advertiserId": "A String", # 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.
+    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+    "publisherTags": [ # Publisher dynamic floodlight tags.
+      { # Publisher Dynamic Tag
+        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+        "siteId": "A String", # Site ID of this dynamic tag.
+        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+        "directorySiteId": "A String", # 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.
+        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      },
+    ],
+    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "hidden": True or False, # Whether this activity is archived.
+    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+    "notes": "A String", # General notes or implementation instructions for the tag.
+    "floodlightConfigurationId": "A String", # 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.
+    "userDefinedVariableTypes": [ # 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.
+        # Acceptable values are:
+        # - "U1"
+        # - "U2"
+        # - "U3"
+        # - "U4"
+        # - "U5"
+        # - "U6"
+        # - "U7"
+        # - "U8"
+        # - "U9"
+        # - "U10"
+        # - "U11"
+        # - "U12"
+        # - "U13"
+        # - "U14"
+        # - "U15"
+        # - "U16"
+        # - "U17"
+        # - "U18"
+        # - "U19"
+        # - "U20"
+      "A String",
+    ],
+    "defaultTags": [ # Dynamic floodlight tags.
+      { # Dynamic Tag
+        "tag": "A String", # Tag code.
+        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this tag.
+      },
+    ],
+    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity.
+      "tagString": "A String", # 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.
+      "secure": True or False, # Whether this tag should use SSL.
+      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+      "advertiserId": "A String", # 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.
+      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+      "publisherTags": [ # Publisher dynamic floodlight tags.
+        { # Publisher Dynamic Tag
+          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+          "siteId": "A String", # Site ID of this dynamic tag.
+          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+            "tag": "A String", # Tag code.
+            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this tag.
+          },
+          "directorySiteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "hidden": True or False, # Whether this activity is archived.
+      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+      "notes": "A String", # General notes or implementation instructions for the tag.
+      "floodlightConfigurationId": "A String", # 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.
+      "userDefinedVariableTypes": [ # 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.
+          # Acceptable values are:
+          # - "U1"
+          # - "U2"
+          # - "U3"
+          # - "U4"
+          # - "U5"
+          # - "U6"
+          # - "U7"
+          # - "U8"
+          # - "U9"
+          # - "U10"
+          # - "U11"
+          # - "U12"
+          # - "U13"
+          # - "U14"
+          # - "U15"
+          # - "U16"
+          # - "U17"
+          # - "U18"
+          # - "U19"
+          # - "U20"
+        "A String",
+      ],
+      "defaultTags": [ # Dynamic floodlight tags.
+        { # Dynamic Tag
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+      ],
+      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing floodlight activity.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity.
+    "tagString": "A String", # 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.
+    "secure": True or False, # Whether this tag should use SSL.
+    "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+    "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+    "advertiserId": "A String", # 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.
+    "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+    "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+    "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+    "publisherTags": [ # Publisher dynamic floodlight tags.
+      { # Publisher Dynamic Tag
+        "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+        "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+        "siteId": "A String", # Site ID of this dynamic tag.
+        "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+        "directorySiteId": "A String", # 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.
+        "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      },
+    ],
+    "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "hidden": True or False, # Whether this activity is archived.
+    "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+    "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+    "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+    "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+    "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+    "notes": "A String", # General notes or implementation instructions for the tag.
+    "floodlightConfigurationId": "A String", # 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.
+    "userDefinedVariableTypes": [ # 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.
+        # Acceptable values are:
+        # - "U1"
+        # - "U2"
+        # - "U3"
+        # - "U4"
+        # - "U5"
+        # - "U6"
+        # - "U7"
+        # - "U8"
+        # - "U9"
+        # - "U10"
+        # - "U11"
+        # - "U12"
+        # - "U13"
+        # - "U14"
+        # - "U15"
+        # - "U16"
+        # - "U17"
+        # - "U18"
+        # - "U19"
+        # - "U20"
+      "A String",
+    ],
+    "defaultTags": [ # Dynamic floodlight tags.
+      { # Dynamic Tag
+        "tag": "A String", # Tag code.
+        "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+        "name": "A String", # Name of this tag.
+      },
+    ],
+    "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+    "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity.
+      "tagString": "A String", # 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.
+      "secure": True or False, # Whether this tag should use SSL.
+      "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field.
+      "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity.
+      "advertiserId": "A String", # 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.
+      "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field.
+      "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field.
+      "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field.
+      "publisherTags": [ # Publisher dynamic floodlight tags.
+        { # Publisher Dynamic Tag
+          "viewThrough": True or False, # Whether this tag is applicable only for view-throughs.
+          "clickThrough": True or False, # Whether this tag is applicable only for click-throughs.
+          "siteId": "A String", # Site ID of this dynamic tag.
+          "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag.
+            "tag": "A String", # Tag code.
+            "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+            "name": "A String", # Name of this tag.
+          },
+          "directorySiteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        },
+      ],
+      "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "hidden": True or False, # Whether this activity is archived.
+      "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank.
+      "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant.
+      "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long.
+      "cacheBustingType": "A String", # Code type used for cache busting in the generated tag.
+      "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.
+      "notes": "A String", # General notes or implementation instructions for the tag.
+      "floodlightConfigurationId": "A String", # 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.
+      "userDefinedVariableTypes": [ # 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.
+          # Acceptable values are:
+          # - "U1"
+          # - "U2"
+          # - "U3"
+          # - "U4"
+          # - "U5"
+          # - "U6"
+          # - "U7"
+          # - "U8"
+          # - "U9"
+          # - "U10"
+          # - "U11"
+          # - "U12"
+          # - "U13"
+          # - "U14"
+          # - "U15"
+          # - "U16"
+          # - "U17"
+          # - "U18"
+          # - "U19"
+          # - "U20"
+        "A String",
+      ],
+      "defaultTags": [ # Dynamic floodlight tags.
+        { # Dynamic Tag
+          "tag": "A String", # Tag code.
+          "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field.
+          "name": "A String", # Name of this tag.
+        },
+      ],
+      "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field.
+      "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.floodlightActivityGroups.html b/docs/dyn/dfareporting_v2_4.floodlightActivityGroups.html new file mode 100644 index 00000000000..0cff6d1b7a2 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.floodlightActivityGroups.html @@ -0,0 +1,488 @@ + + + +

DCM/DFA Reporting And Trafficking API . floodlightActivityGroups

+

Instance Methods

+

+ get(profileId, id)

+

Gets one floodlight activity group by ID.

+

+ insert(profileId, body)

+

Inserts a new floodlight activity group.

+

+ list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None)

+

Retrieves a list of floodlight activity groups, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing floodlight activity group. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing floodlight activity group.

+

Method Details

+
+ get(profileId, id) +
Gets one floodlight activity group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight activity Group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity group.
+      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+      "advertiserId": "A String", # 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.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new floodlight activity group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+    "advertiserId": "A String", # 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.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity group.
+      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+      "advertiserId": "A String", # 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.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, advertiserId=None, searchString=None, pageToken=None, sortField=None, floodlightConfigurationId=None, ids=None, maxResults=None, sortOrder=None, type=None) +
Retrieves a list of floodlight activity groups, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
+  ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  type: string, Select only floodlight activity groups with the specified floodlight activity group type.
+    Allowed values
+      COUNTER - 
+      SALE - 
+
+Returns:
+  An object of the form:
+
+    { # Floodlight Activity Group List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#floodlightActivityGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse".
+    "floodlightActivityGroups": [ # Floodlight activity group collection.
+      { # Contains properties of a Floodlight activity group.
+          "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+          "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+          "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+          "advertiserId": "A String", # 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.
+          "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+          "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing floodlight activity group. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight activity Group ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+    "advertiserId": "A String", # 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.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity group.
+      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+      "advertiserId": "A String", # 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.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing floodlight activity group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight activity group.
+    "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+    "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+    "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+    "advertiserId": "A String", # 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.
+    "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight activity group.
+      "kind": "dfareporting#floodlightActivityGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup".
+      "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes.
+      "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field.
+      "advertiserId": "A String", # 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.
+      "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "tagString": "A String", # 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": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.floodlightConfigurations.html b/docs/dyn/dfareporting_v2_4.floodlightConfigurations.html new file mode 100644 index 00000000000..1b1a7cfbb40 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.floodlightConfigurations.html @@ -0,0 +1,514 @@ + + + +

DCM/DFA Reporting And Trafficking API . floodlightConfigurations

+

Instance Methods

+

+ get(profileId, id)

+

Gets one floodlight configuration by ID.

+

+ list(profileId, ids=None)

+

Retrieves a list of floodlight configurations, possibly filtered.

+

+ patch(profileId, id, body)

+

Updates an existing floodlight configuration. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing floodlight configuration.

+

Method Details

+
+ get(profileId, id) +
Gets one floodlight configuration by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight configuration ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight configuration.
+      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+      "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+        "imageTagEnabled": True or False, # Whether image tags are enabled.
+      },
+      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+          #
+          # Acceptable values are:
+          # - "ORD"
+          # - "NUM"
+        "A String",
+      ],
+      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+      },
+      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+        { # Third Party Authentication Token
+          "name": "A String", # Name of the third-party authentication token.
+          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+        },
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+        { # User Defined Variable configuration.
+          "dataType": "A String", # Data type for the variable. This is a required field.
+          "reportName": "A String", # 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: ""<>".
+          "variableType": "A String", # Variable name in the tag. This is a required field.
+        },
+      ],
+      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, ids=None) +
Retrieves a list of floodlight configurations, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  ids: string, Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Floodlight Configuration List Response
+    "floodlightConfigurations": [ # Floodlight configuration collection.
+      { # Contains properties of a Floodlight configuration.
+          "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+          "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+          "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+            "clickDuration": 42, # 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.
+            "postImpressionActivitiesDuration": 42, # 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.
+          },
+          "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+            "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+            "imageTagEnabled": True or False, # Whether image tags are enabled.
+          },
+          "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+          "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+              #
+              # Acceptable values are:
+              # - "ORD"
+              # - "NUM"
+            "A String",
+          ],
+          "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+            "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+            "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+          },
+          "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+          "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+          "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+          "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+          "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+            { # Third Party Authentication Token
+              "name": "A String", # Name of the third-party authentication token.
+              "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+            },
+          ],
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+          "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+            { # User Defined Variable configuration.
+              "dataType": "A String", # Data type for the variable. This is a required field.
+              "reportName": "A String", # 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: ""<>".
+              "variableType": "A String", # Variable name in the tag. This is a required field.
+            },
+          ],
+          "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+        },
+    ],
+    "kind": "dfareporting#floodlightConfigurationsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfigurationsListResponse".
+  }
+
+ +
+ patch(profileId, id, body) +
Updates an existing floodlight configuration. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Floodlight configuration ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight configuration.
+    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+    "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+      "imageTagEnabled": True or False, # Whether image tags are enabled.
+    },
+    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+        # 
+        # Acceptable values are:
+        # - "ORD"
+        # - "NUM"
+      "A String",
+    ],
+    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+    },
+    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+      { # Third Party Authentication Token
+        "name": "A String", # Name of the third-party authentication token.
+        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+      },
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+      { # User Defined Variable configuration.
+        "dataType": "A String", # Data type for the variable. This is a required field.
+        "reportName": "A String", # 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: ""<>".
+        "variableType": "A String", # Variable name in the tag. This is a required field.
+      },
+    ],
+    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight configuration.
+      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+      "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+        "imageTagEnabled": True or False, # Whether image tags are enabled.
+      },
+      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+          #
+          # Acceptable values are:
+          # - "ORD"
+          # - "NUM"
+        "A String",
+      ],
+      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+      },
+      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+        { # Third Party Authentication Token
+          "name": "A String", # Name of the third-party authentication token.
+          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+        },
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+        { # User Defined Variable configuration.
+          "dataType": "A String", # Data type for the variable. This is a required field.
+          "reportName": "A String", # 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: ""<>".
+          "variableType": "A String", # Variable name in the tag. This is a required field.
+        },
+      ],
+      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing floodlight configuration.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a Floodlight configuration.
+    "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+    "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+    "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+      "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+      "imageTagEnabled": True or False, # Whether image tags are enabled.
+    },
+    "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+    "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+        # 
+        # Acceptable values are:
+        # - "ORD"
+        # - "NUM"
+      "A String",
+    ],
+    "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+      "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+      "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+    },
+    "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+    "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+    "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+    "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+    "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+      { # Third Party Authentication Token
+        "name": "A String", # Name of the third-party authentication token.
+        "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+      },
+    ],
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+    "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+      { # User Defined Variable configuration.
+        "dataType": "A String", # Data type for the variable. This is a required field.
+        "reportName": "A String", # 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: ""<>".
+        "variableType": "A String", # Variable name in the tag. This is a required field.
+      },
+    ],
+    "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a Floodlight configuration.
+      "naturalSearchConversionAttributionOption": "A String", # Types of attribution options for natural search conversions.
+      "kind": "dfareporting#floodlightConfiguration", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightConfiguration".
+      "exposureToConversionEnabled": True or False, # 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": { # Lookback configuration settings. # Lookback window settings for this floodlight configuration.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "tagSettings": { # Dynamic and Image Tag Settings. # Configuration settings for dynamic and image floodlight tags.
+        "dynamicTagEnabled": True or False, # Whether dynamic floodlight tags are enabled.
+        "imageTagEnabled": True or False, # Whether image tags are enabled.
+      },
+      "firstDayOfWeek": "A String", # Day that will be counted as the first day of the week in reports. This is a required field.
+      "standardVariableTypes": [ # List of standard variables enabled for this configuration.
+          #
+          # Acceptable values are:
+          # - "ORD"
+          # - "NUM"
+        "A String",
+      ],
+      "omnitureSettings": { # Omniture Integration Settings. # Settings for DCM Omniture integration.
+        "omnitureCostDataEnabled": True or False, # Whether placement cost data will be sent to Omniture. This property can be enabled only if omnitureIntegrationEnabled is true.
+        "omnitureIntegrationEnabled": True or False, # Whether Omniture integration is enabled. This property can be enabled only when the "Advanced Ad Serving" account setting is enabled.
+      },
+      "subaccountId": "A String", # Subaccount ID of this floodlight configuration. This is a read-only field that can be left blank.
+      "advertiserId": "A String", # Advertiser ID of the parent advertiser of this floodlight configuration.
+      "analyticsDataSharingEnabled": True or False, # Whether advertiser data is shared with Google Analytics.
+      "inAppAttributionTrackingEnabled": True or False, # Whether in-app attribution tracking is enabled.
+      "thirdPartyAuthenticationTokens": [ # List of third-party authentication tokens enabled for this configuration.
+        { # Third Party Authentication Token
+          "name": "A String", # Name of the third-party authentication token.
+          "value": "A String", # Value of the third-party authentication token. This is a read-only, auto-generated field.
+        },
+      ],
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this floodlight configuration. This is a read-only, auto-generated field.
+      "userDefinedVariableConfigurations": [ # List of user defined variables enabled for this configuration.
+        { # User Defined Variable configuration.
+          "dataType": "A String", # Data type for the variable. This is a required field.
+          "reportName": "A String", # 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: ""<>".
+          "variableType": "A String", # Variable name in the tag. This is a required field.
+        },
+      ],
+      "accountId": "A String", # Account ID of this floodlight configuration. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.html b/docs/dyn/dfareporting_v2_4.html new file mode 100644 index 00000000000..74ca9bc8747 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.html @@ -0,0 +1,373 @@ + + + +

DCM/DFA Reporting And Trafficking API

+

Instance Methods

+

+ accountActiveAdSummaries() +

+

Returns the accountActiveAdSummaries Resource.

+ +

+ accountPermissionGroups() +

+

Returns the accountPermissionGroups Resource.

+ +

+ accountPermissions() +

+

Returns the accountPermissions Resource.

+ +

+ accountUserProfiles() +

+

Returns the accountUserProfiles Resource.

+ +

+ accounts() +

+

Returns the accounts Resource.

+ +

+ ads() +

+

Returns the ads Resource.

+ +

+ advertiserGroups() +

+

Returns the advertiserGroups Resource.

+ +

+ advertisers() +

+

Returns the advertisers Resource.

+ +

+ browsers() +

+

Returns the browsers Resource.

+ +

+ campaignCreativeAssociations() +

+

Returns the campaignCreativeAssociations Resource.

+ +

+ campaigns() +

+

Returns the campaigns Resource.

+ +

+ changeLogs() +

+

Returns the changeLogs Resource.

+ +

+ cities() +

+

Returns the cities Resource.

+ +

+ connectionTypes() +

+

Returns the connectionTypes Resource.

+ +

+ contentCategories() +

+

Returns the contentCategories Resource.

+ +

+ countries() +

+

Returns the countries Resource.

+ +

+ creativeAssets() +

+

Returns the creativeAssets Resource.

+ +

+ creativeFieldValues() +

+

Returns the creativeFieldValues Resource.

+ +

+ creativeFields() +

+

Returns the creativeFields Resource.

+ +

+ creativeGroups() +

+

Returns the creativeGroups Resource.

+ +

+ creatives() +

+

Returns the creatives Resource.

+ +

+ dimensionValues() +

+

Returns the dimensionValues Resource.

+ +

+ directorySiteContacts() +

+

Returns the directorySiteContacts Resource.

+ +

+ directorySites() +

+

Returns the directorySites Resource.

+ +

+ eventTags() +

+

Returns the eventTags Resource.

+ +

+ files() +

+

Returns the files Resource.

+ +

+ floodlightActivities() +

+

Returns the floodlightActivities Resource.

+ +

+ floodlightActivityGroups() +

+

Returns the floodlightActivityGroups Resource.

+ +

+ floodlightConfigurations() +

+

Returns the floodlightConfigurations Resource.

+ +

+ inventoryItems() +

+

Returns the inventoryItems Resource.

+ +

+ landingPages() +

+

Returns the landingPages Resource.

+ +

+ metros() +

+

Returns the metros Resource.

+ +

+ mobileCarriers() +

+

Returns the mobileCarriers Resource.

+ +

+ operatingSystemVersions() +

+

Returns the operatingSystemVersions Resource.

+ +

+ operatingSystems() +

+

Returns the operatingSystems Resource.

+ +

+ orderDocuments() +

+

Returns the orderDocuments Resource.

+ +

+ orders() +

+

Returns the orders Resource.

+ +

+ placementGroups() +

+

Returns the placementGroups Resource.

+ +

+ placementStrategies() +

+

Returns the placementStrategies Resource.

+ +

+ placements() +

+

Returns the placements Resource.

+ +

+ platformTypes() +

+

Returns the platformTypes Resource.

+ +

+ postalCodes() +

+

Returns the postalCodes Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ regions() +

+

Returns the regions Resource.

+ +

+ remarketingListShares() +

+

Returns the remarketingListShares Resource.

+ +

+ remarketingLists() +

+

Returns the remarketingLists Resource.

+ +

+ reports() +

+

Returns the reports Resource.

+ +

+ sites() +

+

Returns the sites Resource.

+ +

+ sizes() +

+

Returns the sizes Resource.

+ +

+ subaccounts() +

+

Returns the subaccounts Resource.

+ +

+ targetableRemarketingLists() +

+

Returns the targetableRemarketingLists Resource.

+ +

+ userProfiles() +

+

Returns the userProfiles Resource.

+ +

+ userRolePermissionGroups() +

+

Returns the userRolePermissionGroups Resource.

+ +

+ userRolePermissions() +

+

Returns the userRolePermissions Resource.

+ +

+ userRoles() +

+

Returns the userRoles Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.inventoryItems.html b/docs/dyn/dfareporting_v2_4.inventoryItems.html new file mode 100644 index 00000000000..a280c07864f --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.inventoryItems.html @@ -0,0 +1,250 @@ + + + +

DCM/DFA Reporting And Trafficking API . inventoryItems

+

Instance Methods

+

+ get(profileId, projectId, id)

+

Gets one inventory item by ID.

+

+ list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None)

+

Retrieves a list of inventory items, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, projectId, id) +
Gets one inventory item by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for order documents. (required)
+  id: string, Inventory item ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a buy from the DoubleClick Planning inventory store.
+    "orderId": "A String", # Order ID of this inventory item.
+    "pricing": { # Pricing Information # Pricing of this inventory item.
+      "groupType": "A String", # 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.
+      "startDate": "A String", # Start date of this inventory item.
+      "endDate": "A String", # End date of this inventory item.
+      "pricingType": "A String", # Pricing type of this inventory item.
+      "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
+        { # Flight
+          "rateOrCost": "A String", # Rate or cost of this flight.
+          "startDate": "A String", # Inventory item flight start date.
+          "units": "A String", # Units of this flight.
+          "endDate": "A String", # Inventory item flight end date.
+        },
+      ],
+      "capCostType": "A String", # Cap cost type of this inventory item.
+    },
+    "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
+    "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
+    "subaccountId": "A String", # Subaccount ID of this inventory item.
+    "name": "A String", # 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.
+    "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
+    "inPlan": True or False, # Whether this inventory item is in plan.
+    "id": "A String", # ID of this inventory item.
+    "advertiserId": "A String", # Advertiser ID of this inventory item.
+    "siteId": "A String", # ID of the site this inventory item is associated with.
+    "adSlots": [ # 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.
+      { # Ad Slot
+        "comment": "A String", # Comment for this ad slot.
+        "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
+        "name": "A String", # Name of this ad slot.
+        "primary": True or False, # Primary ad slot of a roadblock inventory item.
+        "height": "A String", # Height of this ad slot.
+        "width": "A String", # Width of this ad slot.
+        "paymentSourceType": "A String", # Payment source type of this ad slot.
+        "compatibility": "A String", # 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.
+      },
+    ],
+    "projectId": "A String", # Project ID of this inventory item.
+    "rfpId": "A String", # RFP ID of this inventory item.
+    "type": "A String", # Type of inventory item.
+    "contentCategoryId": "A String", # Content category ID of this inventory item.
+    "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
+    "accountId": "A String", # Account ID of this inventory item.
+  }
+
+ +
+ list(profileId, projectId, pageToken=None, inPlan=None, sortOrder=None, type=None, orderId=None, maxResults=None, siteId=None, sortField=None, ids=None) +
Retrieves a list of inventory items, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for order documents. (required)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  inPlan: boolean, Select only inventory items that are in plan.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  type: string, Select only inventory items with this type.
+    Allowed values
+      PLANNING_PLACEMENT_TYPE_CREDIT - 
+      PLANNING_PLACEMENT_TYPE_REGULAR - 
+  orderId: string, Select only inventory items that belong to specified orders. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  siteId: string, Select only inventory items that are associated with these sites. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only inventory items with these IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Inventory item List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#inventoryItemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse".
+    "inventoryItems": [ # Inventory item collection
+      { # Represents a buy from the DoubleClick Planning inventory store.
+        "orderId": "A String", # Order ID of this inventory item.
+        "pricing": { # Pricing Information # Pricing of this inventory item.
+          "groupType": "A String", # 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.
+          "startDate": "A String", # Start date of this inventory item.
+          "endDate": "A String", # End date of this inventory item.
+          "pricingType": "A String", # Pricing type of this inventory item.
+          "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.
+            { # Flight
+              "rateOrCost": "A String", # Rate or cost of this flight.
+              "startDate": "A String", # Inventory item flight start date.
+              "units": "A String", # Units of this flight.
+              "endDate": "A String", # Inventory item flight end date.
+            },
+          ],
+          "capCostType": "A String", # Cap cost type of this inventory item.
+        },
+        "kind": "dfareporting#inventoryItem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem".
+        "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item.
+        "subaccountId": "A String", # Subaccount ID of this inventory item.
+        "name": "A String", # 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.
+        "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item.
+        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item.
+          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+        },
+        "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item.
+        "inPlan": True or False, # Whether this inventory item is in plan.
+        "id": "A String", # ID of this inventory item.
+        "advertiserId": "A String", # Advertiser ID of this inventory item.
+        "siteId": "A String", # ID of the site this inventory item is associated with.
+        "adSlots": [ # 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.
+          { # Ad Slot
+            "comment": "A String", # Comment for this ad slot.
+            "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot.
+            "name": "A String", # Name of this ad slot.
+            "primary": True or False, # Primary ad slot of a roadblock inventory item.
+            "height": "A String", # Height of this ad slot.
+            "width": "A String", # Width of this ad slot.
+            "paymentSourceType": "A String", # Payment source type of this ad slot.
+            "compatibility": "A String", # 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.
+          },
+        ],
+        "projectId": "A String", # Project ID of this inventory item.
+        "rfpId": "A String", # RFP ID of this inventory item.
+        "type": "A String", # Type of inventory item.
+        "contentCategoryId": "A String", # Content category ID of this inventory item.
+        "placementStrategyId": "A String", # Placement strategy ID of this inventory item.
+        "accountId": "A String", # Account ID of this inventory item.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.landingPages.html b/docs/dyn/dfareporting_v2_4.landingPages.html new file mode 100644 index 00000000000..e2c37b97450 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.landingPages.html @@ -0,0 +1,247 @@ + + + +

DCM/DFA Reporting And Trafficking API . landingPages

+

Instance Methods

+

+ delete(profileId, campaignId, id)

+

Deletes an existing campaign landing page.

+

+ get(profileId, campaignId, id)

+

Gets one campaign landing page by ID.

+

+ insert(profileId, campaignId, body)

+

Inserts a new landing page for the specified campaign.

+

+ list(profileId, campaignId)

+

Retrieves the list of landing pages for the specified campaign.

+

+ patch(profileId, campaignId, id, body)

+

Updates an existing campaign landing page. This method supports patch semantics.

+

+ update(profileId, campaignId, body)

+

Updates an existing campaign landing page.

+

Method Details

+
+ delete(profileId, campaignId, id) +
Deletes an existing campaign landing page.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+  id: string, Landing page ID. (required)
+
+
+ +
+ get(profileId, campaignId, id) +
Gets one campaign landing page by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+  id: string, Landing page ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about where a user's browser is taken after the user clicks an ad.
+      "default": True or False, # 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.
+      "url": "A String", # URL of this landing page. This is a required field.
+      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+    }
+
+ +
+ insert(profileId, campaignId, body) +
Inserts a new landing page for the specified campaign.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+    "default": True or False, # 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.
+    "url": "A String", # URL of this landing page. This is a required field.
+    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains information about where a user's browser is taken after the user clicks an ad.
+      "default": True or False, # 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.
+      "url": "A String", # URL of this landing page. This is a required field.
+      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+    }
+
+ +
+ list(profileId, campaignId) +
Retrieves the list of landing pages for the specified campaign.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Landing Page List Response
+    "kind": "dfareporting#landingPagesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPagesListResponse".
+    "landingPages": [ # Landing page collection
+      { # Contains information about where a user's browser is taken after the user clicks an ad.
+          "default": True or False, # 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.
+          "url": "A String", # URL of this landing page. This is a required field.
+          "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+          "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+          "name": "A String", # 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.
+        },
+    ],
+  }
+
+ +
+ patch(profileId, campaignId, id, body) +
Updates an existing campaign landing page. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+  id: string, Landing page ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+    "default": True or False, # 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.
+    "url": "A String", # URL of this landing page. This is a required field.
+    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains information about where a user's browser is taken after the user clicks an ad.
+      "default": True or False, # 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.
+      "url": "A String", # URL of this landing page. This is a required field.
+      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+    }
+
+ +
+ update(profileId, campaignId, body) +
Updates an existing campaign landing page.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Landing page campaign ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains information about where a user's browser is taken after the user clicks an ad.
+    "default": True or False, # 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.
+    "url": "A String", # URL of this landing page. This is a required field.
+    "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+    "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains information about where a user's browser is taken after the user clicks an ad.
+      "default": True or False, # 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.
+      "url": "A String", # URL of this landing page. This is a required field.
+      "kind": "dfareporting#landingPage", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#landingPage".
+      "id": "A String", # ID of this landing page. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.metros.html b/docs/dyn/dfareporting_v2_4.metros.html new file mode 100644 index 00000000000..1b40ec6a8b6 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.metros.html @@ -0,0 +1,107 @@ + + + +

DCM/DFA Reporting And Trafficking API . metros

+

Instance Methods

+

+ list(profileId)

+

Retrieves a list of metros.

+

Method Details

+
+ list(profileId) +
Retrieves a list of metros.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Metro List Response
+    "kind": "dfareporting#metrosListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metrosListResponse".
+    "metros": [ # Metro collection.
+      { # Contains information about a metro region that can be targeted by ads.
+        "kind": "dfareporting#metro", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#metro".
+        "countryDartId": "A String", # DART ID of the country to which this metro region belongs.
+        "name": "A String", # Name of this metro region.
+        "countryCode": "A String", # Country code of the country to which this metro region belongs.
+        "metroCode": "A String", # Metro code of this metro region. This is equivalent to dma_id.
+        "dmaId": "A String", # DMA ID of this metro region. This is the ID used for targeting and generating reports, and is equivalent to metro_code.
+        "dartId": "A String", # DART ID of this metro region.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.mobileCarriers.html b/docs/dyn/dfareporting_v2_4.mobileCarriers.html new file mode 100644 index 00000000000..3b89e0c5d46 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.mobileCarriers.html @@ -0,0 +1,128 @@ + + + +

DCM/DFA Reporting And Trafficking API . mobileCarriers

+

Instance Methods

+

+ get(profileId, id)

+

Gets one mobile carrier by ID.

+

+ list(profileId)

+

Retrieves a list of mobile carriers.

+

Method Details

+
+ get(profileId, id) +
Gets one mobile carrier by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Mobile carrier ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about a mobile carrier that can be targeted by ads.
+    "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+    "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+    "id": "A String", # ID of this mobile carrier.
+    "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+    "name": "A String", # Name of this mobile carrier.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of mobile carriers.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Mobile Carrier List Response
+    "kind": "dfareporting#mobileCarriersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarriersListResponse".
+    "mobileCarriers": [ # Mobile carrier collection.
+      { # Contains information about a mobile carrier that can be targeted by ads.
+        "kind": "dfareporting#mobileCarrier", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileCarrier".
+        "countryDartId": "A String", # DART ID of the country to which this mobile carrier belongs.
+        "id": "A String", # ID of this mobile carrier.
+        "countryCode": "A String", # Country code of the country to which this mobile carrier belongs.
+        "name": "A String", # Name of this mobile carrier.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.operatingSystemVersions.html b/docs/dyn/dfareporting_v2_4.operatingSystemVersions.html new file mode 100644 index 00000000000..d07674ea33f --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.operatingSystemVersions.html @@ -0,0 +1,142 @@ + + + +

DCM/DFA Reporting And Trafficking API . operatingSystemVersions

+

Instance Methods

+

+ get(profileId, id)

+

Gets one operating system version by ID.

+

+ list(profileId)

+

Retrieves a list of operating system versions.

+

Method Details

+
+ get(profileId, id) +
Gets one operating system version by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Operating system version ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about a particular version of an operating system that can be targeted by ads.
+    "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+    "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+    "name": "A String", # Name of this operating system version.
+    "id": "A String", # ID of this operating system version.
+    "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+      "mobile": True or False, # Whether this operating system is for mobile.
+      "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+      "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+      "name": "A String", # Name of this operating system.
+      "desktop": True or False, # Whether this operating system is for desktop.
+    },
+    "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of operating system versions.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Operating System Version List Response
+    "kind": "dfareporting#operatingSystemVersionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersionsListResponse".
+    "operatingSystemVersions": [ # Operating system version collection.
+      { # Contains information about a particular version of an operating system that can be targeted by ads.
+        "majorVersion": "A String", # Major version (leftmost number) of this operating system version.
+        "kind": "dfareporting#operatingSystemVersion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemVersion".
+        "name": "A String", # Name of this operating system version.
+        "id": "A String", # ID of this operating system version.
+        "operatingSystem": { # Contains information about an operating system that can be targeted by ads. # Operating system of this operating system version.
+          "mobile": True or False, # Whether this operating system is for mobile.
+          "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+          "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+          "name": "A String", # Name of this operating system.
+          "desktop": True or False, # Whether this operating system is for desktop.
+        },
+        "minorVersion": "A String", # Minor version (number after the first dot) of this operating system version.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.operatingSystems.html b/docs/dyn/dfareporting_v2_4.operatingSystems.html new file mode 100644 index 00000000000..da7183b7534 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.operatingSystems.html @@ -0,0 +1,128 @@ + + + +

DCM/DFA Reporting And Trafficking API . operatingSystems

+

Instance Methods

+

+ get(profileId, dartId)

+

Gets one operating system by DART ID.

+

+ list(profileId)

+

Retrieves a list of operating systems.

+

Method Details

+
+ get(profileId, dartId) +
Gets one operating system by DART ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  dartId: string, Operating system DART ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about an operating system that can be targeted by ads.
+    "mobile": True or False, # Whether this operating system is for mobile.
+    "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+    "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+    "name": "A String", # Name of this operating system.
+    "desktop": True or False, # Whether this operating system is for desktop.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of operating systems.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Operating System List Response
+    "kind": "dfareporting#operatingSystemsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystemsListResponse".
+    "operatingSystems": [ # Operating system collection.
+      { # Contains information about an operating system that can be targeted by ads.
+        "mobile": True or False, # Whether this operating system is for mobile.
+        "dartId": "A String", # DART ID of this operating system. This is the ID used for targeting.
+        "kind": "dfareporting#operatingSystem", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#operatingSystem".
+        "name": "A String", # Name of this operating system.
+        "desktop": True or False, # Whether this operating system is for desktop.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.orderDocuments.html b/docs/dyn/dfareporting_v2_4.orderDocuments.html new file mode 100644 index 00000000000..a8acfc56a5a --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.orderDocuments.html @@ -0,0 +1,199 @@ + + + +

DCM/DFA Reporting And Trafficking API . orderDocuments

+

Instance Methods

+

+ get(profileId, projectId, id)

+

Gets one order document by ID.

+

+ list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None)

+

Retrieves a list of order documents, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, projectId, id) +
Gets one order document by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for order documents. (required)
+  id: string, Order document ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DoubleClick Planning order document.
+    "orderId": "A String", # ID of the order from which this order document is created.
+    "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
+      "A String",
+    ],
+    "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
+    "subaccountId": "A String", # Subaccount ID of this order document.
+    "effectiveDate": "A String", # Effective date of this order document.
+    "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
+    "lastSentRecipients": [ # List of email addresses that received the last sent document.
+      "A String",
+    ],
+    "title": "A String", # Title of this order document.
+    "amendedOrderDocumentId": "A String", # 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.
+    "signed": True or False, # Whether this order document has been signed.
+    "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "advertiserId": "A String", # Advertiser ID of this order document.
+    "projectId": "A String", # Project ID of this order document.
+    "cancelled": True or False, # Whether this order document is cancelled.
+    "type": "A String", # Type of this order document
+    "id": "A String", # ID of this order document.
+    "accountId": "A String", # Account ID of this order document.
+  }
+
+ +
+ list(profileId, projectId, pageToken=None, sortOrder=None, orderId=None, maxResults=None, siteId=None, approved=None, searchString=None, sortField=None, ids=None) +
Retrieves a list of order documents, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for order documents. (required)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  orderId: string, Select only order documents for specified orders. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  siteId: string, Select only order documents that are associated with these sites. (repeated)
+  approved: boolean, Select only order documents that have been approved by at least one user.
+  searchString: string, 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".
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only order documents with these IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Order document List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#orderDocumentsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocumentsListResponse".
+    "orderDocuments": [ # Order document collection
+      { # Contains properties of a DoubleClick Planning order document.
+        "orderId": "A String", # ID of the order from which this order document is created.
+        "approvedByUserProfileIds": [ # IDs of users who have approved this order document.
+          "A String",
+        ],
+        "kind": "dfareporting#orderDocument", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#orderDocument".
+        "subaccountId": "A String", # Subaccount ID of this order document.
+        "effectiveDate": "A String", # Effective date of this order document.
+        "lastSentTime": "A String", # Timestamp of the last email sent with this order document.
+        "lastSentRecipients": [ # List of email addresses that received the last sent document.
+          "A String",
+        ],
+        "title": "A String", # Title of this order document.
+        "amendedOrderDocumentId": "A String", # 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.
+        "signed": True or False, # Whether this order document has been signed.
+        "createdInfo": { # Modification timestamp. # Information about the creation of this order document.
+          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+        },
+        "advertiserId": "A String", # Advertiser ID of this order document.
+        "projectId": "A String", # Project ID of this order document.
+        "cancelled": True or False, # Whether this order document is cancelled.
+        "type": "A String", # Type of this order document
+        "id": "A String", # ID of this order document.
+        "accountId": "A String", # Account ID of this order document.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.orders.html b/docs/dyn/dfareporting_v2_4.orders.html new file mode 100644 index 00000000000..a966db57acd --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.orders.html @@ -0,0 +1,223 @@ + + + +

DCM/DFA Reporting And Trafficking API . orders

+

Instance Methods

+

+ get(profileId, projectId, id)

+

Gets one order by ID.

+

+ list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None)

+

Retrieves a list of orders, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, projectId, id) +
Gets one order by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for orders. (required)
+  id: string, Order ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Describes properties of a DoubleClick Planning order.
+    "termsAndConditions": "A String", # Terms and conditions of this order.
+    "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
+    "sellerOrganizationName": "A String", # Name of the seller organization.
+    "subaccountId": "A String", # Subaccount ID of this order.
+    "name": "A String", # Name of this order.
+    "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "notes": "A String", # Notes of this order.
+    "contacts": [ # Contacts for this order.
+      { # Contact of an order.
+        "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
+        "contactTitle": "A String", # Title of this contact.
+        "contactInfo": "A String", # 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": "A String", # Name of this contact.
+        "contactType": "A String", # Type of this contact.
+      },
+    ],
+    "buyerOrganizationName": "A String", # Name of the buyer organization.
+    "comments": "A String", # Comments in this order.
+    "advertiserId": "A String", # Advertiser ID of this order.
+    "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
+      "A String",
+    ],
+    "siteId": [ # Site IDs this order is associated with.
+      "A String",
+    ],
+    "sellerOrderId": "A String", # Seller order ID associated with this order.
+    "projectId": "A String", # Project ID of this order.
+    "siteNames": [ # Free-form site names this order is associated with.
+      "A String",
+    ],
+    "planningTermId": "A String", # ID of the terms and conditions template used in this order.
+    "id": "A String", # ID of this order. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this order.
+  }
+
+ +
+ list(profileId, projectId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None, siteId=None) +
Retrieves a list of orders, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  projectId: string, Project ID for orders. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only orders with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  siteId: string, Select only orders that are associated with these site IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Order List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#ordersListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#ordersListResponse".
+    "orders": [ # Order collection.
+      { # Describes properties of a DoubleClick Planning order.
+        "termsAndConditions": "A String", # Terms and conditions of this order.
+        "kind": "dfareporting#order", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#order".
+        "sellerOrganizationName": "A String", # Name of the seller organization.
+        "subaccountId": "A String", # Subaccount ID of this order.
+        "name": "A String", # Name of this order.
+        "buyerInvoiceId": "A String", # Buyer invoice ID associated with this order.
+        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this order.
+          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+        },
+        "notes": "A String", # Notes of this order.
+        "contacts": [ # Contacts for this order.
+          { # Contact of an order.
+            "signatureUserProfileId": "A String", # ID of the user profile containing the signature that will be embedded into order documents.
+            "contactTitle": "A String", # Title of this contact.
+            "contactInfo": "A String", # 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": "A String", # Name of this contact.
+            "contactType": "A String", # Type of this contact.
+          },
+        ],
+        "buyerOrganizationName": "A String", # Name of the buyer organization.
+        "comments": "A String", # Comments in this order.
+        "advertiserId": "A String", # Advertiser ID of this order.
+        "approverUserProfileIds": [ # IDs for users that have to approve documents created for this order.
+          "A String",
+        ],
+        "siteId": [ # Site IDs this order is associated with.
+          "A String",
+        ],
+        "sellerOrderId": "A String", # Seller order ID associated with this order.
+        "projectId": "A String", # Project ID of this order.
+        "siteNames": [ # Free-form site names this order is associated with.
+          "A String",
+        ],
+        "planningTermId": "A String", # ID of the terms and conditions template used in this order.
+        "id": "A String", # ID of this order. This is a read-only, auto-generated field.
+        "accountId": "A String", # Account ID of this order.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.placementGroups.html b/docs/dyn/dfareporting_v2_4.placementGroups.html new file mode 100644 index 00000000000..c76ce19ef18 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.placementGroups.html @@ -0,0 +1,976 @@ + + + +

DCM/DFA Reporting And Trafficking API . placementGroups

+

Instance Methods

+

+ get(profileId, id)

+

Gets one placement group by ID.

+

+ insert(profileId, body)

+

Inserts a new placement group.

+

+ list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None)

+

Retrieves a list of placement groups, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing placement group. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing placement group.

+

Method Details

+
+ get(profileId, id) +
Gets one placement group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a package or roadblock.
+      "comment": "A String", # Comments for this placement group.
+      "primaryPlacementId": "A String", # 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.
+      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+      "directorySiteId": "A String", # 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.
+      "placementGroupType": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this placement group is archived.
+      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+        "A String",
+      ],
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new placement group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+    "comment": "A String", # Comments for this placement group.
+    "primaryPlacementId": "A String", # 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.
+    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+    "directorySiteId": "A String", # 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.
+    "placementGroupType": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this placement group is archived.
+    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+      "A String",
+    ],
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a package or roadblock.
+      "comment": "A String", # Comments for this placement group.
+      "primaryPlacementId": "A String", # 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.
+      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+      "directorySiteId": "A String", # 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.
+      "placementGroupType": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this placement group is archived.
+      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+        "A String",
+      ],
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ list(profileId, siteIds=None, placementGroupType=None, pricingTypes=None, campaignIds=None, advertiserIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, searchString=None, minEndDate=None, directorySiteIds=None, ids=None, sortField=None) +
Retrieves a list of placement groups, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
+  placementGroupType: string, 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.
+    Allowed values
+      PLACEMENT_PACKAGE - 
+      PLACEMENT_ROADBLOCK - 
+  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
+    Allowed values
+      PRICING_TYPE_CPA - 
+      PRICING_TYPE_CPC - 
+      PRICING_TYPE_CPM - 
+      PRICING_TYPE_FLAT_RATE_CLICKS - 
+      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
+  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
+  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  maxStartDate: string, 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".
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  maxEndDate: string, 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".
+  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
+  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
+  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
+  maxResults: integer, Maximum number of results to return.
+  minStartDate: string, 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".
+  searchString: string, 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".
+  minEndDate: string, 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".
+  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
+  ids: string, Select only placement groups with these IDs. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+
+Returns:
+  An object of the form:
+
+    { # Placement Group List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#placementGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse".
+    "placementGroups": [ # Placement group collection.
+      { # Contains properties of a package or roadblock.
+          "comment": "A String", # Comments for this placement group.
+          "primaryPlacementId": "A String", # 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.
+          "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+          "directorySiteId": "A String", # 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.
+          "placementGroupType": "A String", # 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.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+          "archived": True or False, # Whether this placement group is archived.
+          "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+            "A String",
+          ],
+          "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+          "externalId": "A String", # External ID for this placement.
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "siteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+          "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+          "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+          "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+            "capCostOption": "A String", # Placement cap cost option.
+            "pricingPeriods": [ # Pricing periods for this placement.
+              { # Pricing Period
+                "units": "A String", # Units of this pricing period.
+                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+                "startDate": "A String", # 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.
+                "endDate": "A String", # 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.
+                "pricingComment": "A String", # Comments for this pricing period.
+              },
+            ],
+            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+            "testingStartDate": "A String", # 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.
+            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+          },
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing placement group. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement group ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+    "comment": "A String", # Comments for this placement group.
+    "primaryPlacementId": "A String", # 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.
+    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+    "directorySiteId": "A String", # 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.
+    "placementGroupType": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this placement group is archived.
+    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+      "A String",
+    ],
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a package or roadblock.
+      "comment": "A String", # Comments for this placement group.
+      "primaryPlacementId": "A String", # 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.
+      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+      "directorySiteId": "A String", # 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.
+      "placementGroupType": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this placement group is archived.
+      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+        "A String",
+      ],
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ update(profileId, body) +
Updates an existing placement group.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a package or roadblock.
+    "comment": "A String", # Comments for this placement group.
+    "primaryPlacementId": "A String", # 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.
+    "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+    "directorySiteId": "A String", # 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.
+    "placementGroupType": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+    "archived": True or False, # Whether this placement group is archived.
+    "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+      "A String",
+    ],
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+    "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+    "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+    "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a package or roadblock.
+      "comment": "A String", # Comments for this placement group.
+      "primaryPlacementId": "A String", # 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.
+      "campaignId": "A String", # Campaign ID of this placement group. This field is required on insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement group. This is a required field on insertion.
+      "directorySiteId": "A String", # 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.
+      "placementGroupType": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement group. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement group. This is a read-only field that can be left blank.
+      "archived": True or False, # Whether this placement group is archived.
+      "childPlacementIds": [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
+        "A String",
+      ],
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement group.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primaryPlacementIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement group.
+      "kind": "dfareporting#placementGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup".
+      "subaccountId": "A String", # Subaccount ID of this placement group. This is a read-only field that can be left blank.
+      "name": "A String", # Name of this placement group. This is a required field and must be less than 256 characters long.
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.placementStrategies.html b/docs/dyn/dfareporting_v2_4.placementStrategies.html new file mode 100644 index 00000000000..a2f1cb50173 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.placementStrategies.html @@ -0,0 +1,263 @@ + + + +

DCM/DFA Reporting And Trafficking API . placementStrategies

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing placement strategy.

+

+ get(profileId, id)

+

Gets one placement strategy by ID.

+

+ insert(profileId, body)

+

Inserts a new placement strategy.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of placement strategies, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing placement strategy. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing placement strategy.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing placement strategy.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement strategy ID. (required)
+
+
+ +
+ get(profileId, id) +
Gets one placement strategy by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement strategy ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement strategy.
+      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new placement strategy.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement strategy.
+      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of placement strategies, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only placement strategies with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Placement Strategy List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#placementStrategiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategiesListResponse".
+    "placementStrategies": [ # Placement strategy collection.
+      { # Contains properties of a placement strategy.
+          "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+          "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+          "name": "A String", # 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.
+          "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing placement strategy. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement strategy ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement strategy.
+      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing placement strategy.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement strategy.
+    "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+    "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement strategy.
+      "kind": "dfareporting#placementStrategy", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementStrategy".
+      "id": "A String", # ID of this placement strategy. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # Account ID of this placement strategy.This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.placements.html b/docs/dyn/dfareporting_v2_4.placements.html new file mode 100644 index 00000000000..d3fcbd74c49 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.placements.html @@ -0,0 +1,1359 @@ + + + +

DCM/DFA Reporting And Trafficking API . placements

+

Instance Methods

+

+ generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None)

+

Generates tags for a placement.

+

+ get(profileId, id)

+

Gets one placement by ID.

+

+ insert(profileId, body)

+

Inserts a new placement.

+

+ list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None)

+

Retrieves a list of placements, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing placement. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing placement.

+

Method Details

+
+ generatetags(profileId, campaignId=None, tagFormats=None, placementIds=None) +
Generates tags for a placement.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  campaignId: string, Generate placements belonging to this campaign. This is a required field.
+  tagFormats: string, Tag formats to generate for these placements. (repeated)
+    Allowed values
+      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 - 
+  placementIds: string, Generate tags for these placements. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Placement GenerateTags Response
+    "kind": "dfareporting#placementsGenerateTagsResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
+    "placementTags": [ # Set of generated tags for the specified placements.
+      { # Placement Tag
+        "tagDatas": [ # Tags generated for this placement.
+          { # Placement Tag Data
+            "clickTag": "A String", # Tag string to record a click.
+            "impressionTag": "A String", # Tag string for serving an ad.
+            "creativeId": "A String", # Creative associated with this placement tag.
+            "adId": "A String", # Ad associated with this placement tag.
+            "format": "A String", # TagData tag format of this tag.
+          },
+        ],
+        "placementId": "A String", # Placement ID
+      },
+    ],
+  }
+
+ +
+ get(profileId, id) +
Gets one placement by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement.
+      "comment": "A String", # Comments for this placement.
+      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement. This field can be left blank.
+      "archived": True or False, # Whether this placement is archived.
+      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+          # Acceptable values are:
+          # - "PLACEMENT_TAG_STANDARD"
+          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_IFRAME_ILAYER"
+          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+          # - "PLACEMENT_TAG_CLICK_COMMANDS"
+          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+          # - "PLACEMENT_TAG_TRACKING"
+          # - "PLACEMENT_TAG_TRACKING_IFRAME"
+          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+        "A String",
+      ],
+      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+      "tagSetting": { # Tag Settings # Tag settings for this placement.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+      "status": "A String", # Third-party placement status.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primary": True or False, # 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.
+      "placementGroupId": "A String", # ID of this placement's group, if applicable.
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "compatibility": "A String", # 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.
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new placement.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement.
+    "comment": "A String", # Comments for this placement.
+    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement. This field can be left blank.
+    "archived": True or False, # Whether this placement is archived.
+    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+        # Acceptable values are:
+        # - "PLACEMENT_TAG_STANDARD"
+        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_IFRAME_ILAYER"
+        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+        # - "PLACEMENT_TAG_CLICK_COMMANDS"
+        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+        # - "PLACEMENT_TAG_TRACKING"
+        # - "PLACEMENT_TAG_TRACKING_IFRAME"
+        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+      "A String",
+    ],
+    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+    "tagSetting": { # Tag Settings # Tag settings for this placement.
+      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+      "additionalKeyValues": "A String", # 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.
+      "keywordOption": "A String", # 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.
+    },
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+    "status": "A String", # Third-party placement status.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primary": True or False, # 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.
+    "placementGroupId": "A String", # ID of this placement's group, if applicable.
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "compatibility": "A String", # 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.
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement.
+      "comment": "A String", # Comments for this placement.
+      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement. This field can be left blank.
+      "archived": True or False, # Whether this placement is archived.
+      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+          # Acceptable values are:
+          # - "PLACEMENT_TAG_STANDARD"
+          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_IFRAME_ILAYER"
+          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+          # - "PLACEMENT_TAG_CLICK_COMMANDS"
+          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+          # - "PLACEMENT_TAG_TRACKING"
+          # - "PLACEMENT_TAG_TRACKING_IFRAME"
+          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+        "A String",
+      ],
+      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+      "tagSetting": { # Tag Settings # Tag settings for this placement.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+      "status": "A String", # Third-party placement status.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primary": True or False, # 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.
+      "placementGroupId": "A String", # ID of this placement's group, if applicable.
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "compatibility": "A String", # 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.
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ list(profileId, siteIds=None, paymentSource=None, pricingTypes=None, campaignIds=None, advertiserIds=None, sizeIds=None, pageToken=None, maxStartDate=None, sortOrder=None, maxEndDate=None, placementStrategyIds=None, contentCategoryIds=None, archived=None, maxResults=None, minStartDate=None, compatibilities=None, searchString=None, minEndDate=None, directorySiteIds=None, sortField=None, ids=None, groupIds=None) +
Retrieves a list of placements, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  siteIds: string, Select only placements that are associated with these sites. (repeated)
+  paymentSource: string, Select only placements with this payment source.
+    Allowed values
+      PLACEMENT_AGENCY_PAID - 
+      PLACEMENT_PUBLISHER_PAID - 
+  pricingTypes: string, Select only placements with these pricing types. (repeated)
+    Allowed values
+      PRICING_TYPE_CPA - 
+      PRICING_TYPE_CPC - 
+      PRICING_TYPE_CPM - 
+      PRICING_TYPE_FLAT_RATE_CLICKS - 
+      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
+  campaignIds: string, Select only placements that belong to these campaigns. (repeated)
+  advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
+  sizeIds: string, Select only placements that are associated with these sizes. (repeated)
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  maxStartDate: string, 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".
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  maxEndDate: string, 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".
+  placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
+  contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
+  archived: boolean, Select only archived placements. Don't set this field to select both archived and non-archived placements.
+  maxResults: integer, Maximum number of results to return.
+  minStartDate: string, 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".
+  compatibilities: string, 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. (repeated)
+    Allowed values
+      APP - 
+      APP_INTERSTITIAL - 
+      DISPLAY - 
+      DISPLAY_INTERSTITIAL - 
+      IN_STREAM_VIDEO - 
+  searchString: string, 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".
+  minEndDate: string, 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".
+  directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only placements with these IDs. (repeated)
+  groupIds: string, Select only placements that belong to these placement groups. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Placement List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#placementsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
+    "placements": [ # Placement collection.
+      { # Contains properties of a placement.
+          "comment": "A String", # Comments for this placement.
+          "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+          "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+          "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+          "directorySiteId": "A String", # 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.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this placement. This field can be left blank.
+          "archived": True or False, # Whether this placement is archived.
+          "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+              # Acceptable values are:
+              # - "PLACEMENT_TAG_STANDARD"
+              # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+              # - "PLACEMENT_TAG_IFRAME_ILAYER"
+              # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+              # - "PLACEMENT_TAG_JAVASCRIPT"
+              # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+              # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+              # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+              # - "PLACEMENT_TAG_CLICK_COMMANDS"
+              # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+              # - "PLACEMENT_TAG_TRACKING"
+              # - "PLACEMENT_TAG_TRACKING_IFRAME"
+              # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+            "A String",
+          ],
+          "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+          "tagSetting": { # Tag Settings # Tag settings for this placement.
+            "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+            "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+            "additionalKeyValues": "A String", # 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.
+            "keywordOption": "A String", # 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.
+          },
+          "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+          "externalId": "A String", # External ID for this placement.
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+            "width": 42, # Width of this size.
+            "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+            "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+            "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+            "height": 42, # Height of this size.
+          },
+          "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+          "status": "A String", # Third-party placement status.
+          "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "primary": True or False, # 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.
+          "placementGroupId": "A String", # ID of this placement's group, if applicable.
+          "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "siteId": "A String", # 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.
+          "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "compatibility": "A String", # 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.
+          "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+          "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+          "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+          "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+          "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+            "clickDuration": 42, # 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.
+            "postImpressionActivitiesDuration": 42, # 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.
+          },
+          "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+            "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+          },
+          "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+            "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+            "capCostOption": "A String", # Placement cap cost option.
+            "pricingPeriods": [ # Pricing periods for this placement.
+              { # Pricing Period
+                "units": "A String", # Units of this pricing period.
+                "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+                "startDate": "A String", # 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.
+                "endDate": "A String", # 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.
+                "pricingComment": "A String", # Comments for this pricing period.
+              },
+            ],
+            "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+            "testingStartDate": "A String", # 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.
+            "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+          },
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing placement. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Placement ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement.
+    "comment": "A String", # Comments for this placement.
+    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement. This field can be left blank.
+    "archived": True or False, # Whether this placement is archived.
+    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+        # Acceptable values are:
+        # - "PLACEMENT_TAG_STANDARD"
+        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_IFRAME_ILAYER"
+        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+        # - "PLACEMENT_TAG_CLICK_COMMANDS"
+        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+        # - "PLACEMENT_TAG_TRACKING"
+        # - "PLACEMENT_TAG_TRACKING_IFRAME"
+        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+      "A String",
+    ],
+    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+    "tagSetting": { # Tag Settings # Tag settings for this placement.
+      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+      "additionalKeyValues": "A String", # 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.
+      "keywordOption": "A String", # 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.
+    },
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+    "status": "A String", # Third-party placement status.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primary": True or False, # 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.
+    "placementGroupId": "A String", # ID of this placement's group, if applicable.
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "compatibility": "A String", # 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.
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement.
+      "comment": "A String", # Comments for this placement.
+      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement. This field can be left blank.
+      "archived": True or False, # Whether this placement is archived.
+      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+          # Acceptable values are:
+          # - "PLACEMENT_TAG_STANDARD"
+          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_IFRAME_ILAYER"
+          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+          # - "PLACEMENT_TAG_CLICK_COMMANDS"
+          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+          # - "PLACEMENT_TAG_TRACKING"
+          # - "PLACEMENT_TAG_TRACKING_IFRAME"
+          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+        "A String",
+      ],
+      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+      "tagSetting": { # Tag Settings # Tag settings for this placement.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+      "status": "A String", # Third-party placement status.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primary": True or False, # 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.
+      "placementGroupId": "A String", # ID of this placement's group, if applicable.
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "compatibility": "A String", # 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.
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ +
+ update(profileId, body) +
Updates an existing placement.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a placement.
+    "comment": "A String", # Comments for this placement.
+    "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+    "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+    "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # 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.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this placement. This field can be left blank.
+    "archived": True or False, # Whether this placement is archived.
+    "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+        # Acceptable values are:
+        # - "PLACEMENT_TAG_STANDARD"
+        # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_IFRAME_ILAYER"
+        # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+        # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+        # - "PLACEMENT_TAG_CLICK_COMMANDS"
+        # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+        # - "PLACEMENT_TAG_TRACKING"
+        # - "PLACEMENT_TAG_TRACKING_IFRAME"
+        # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+      "A String",
+    ],
+    "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+    "tagSetting": { # Tag Settings # Tag settings for this placement.
+      "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+      "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+      "additionalKeyValues": "A String", # 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.
+      "keywordOption": "A String", # 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.
+    },
+    "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+    "externalId": "A String", # External ID for this placement.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+      "width": 42, # Width of this size.
+      "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+      "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+      "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+      "height": 42, # Height of this size.
+    },
+    "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+    "status": "A String", # Third-party placement status.
+    "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "primary": True or False, # 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.
+    "placementGroupId": "A String", # ID of this placement's group, if applicable.
+    "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "siteId": "A String", # 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.
+    "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "compatibility": "A String", # 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.
+    "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+    "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+    "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+    "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+    "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+      "clickDuration": 42, # 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.
+      "postImpressionActivitiesDuration": 42, # 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.
+    },
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+      "startDate": "A String", # 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.
+      "endDate": "A String", # 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.
+      "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+      "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+      "capCostOption": "A String", # Placement cap cost option.
+      "pricingPeriods": [ # Pricing periods for this placement.
+        { # Pricing Period
+          "units": "A String", # Units of this pricing period.
+          "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+          "startDate": "A String", # 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.
+          "endDate": "A String", # 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.
+          "pricingComment": "A String", # Comments for this pricing period.
+        },
+      ],
+      "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+      "testingStartDate": "A String", # 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.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+    },
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a placement.
+      "comment": "A String", # Comments for this placement.
+      "campaignId": "A String", # Campaign ID of this placement. This field is a required field on insertion.
+      "paymentSource": "A String", # Payment source for this placement. This is a required field that is read-only after insertion.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "advertiserId": "A String", # Advertiser ID of this placement. This field can be left blank.
+      "keyName": "A String", # Key name of this placement. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # 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.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # ID of this placement. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this placement. This field can be left blank.
+      "archived": True or False, # Whether this placement is archived.
+      "publisherUpdateInfo": { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "tagFormats": [ # Tag formats to generate for this placement. This field is required on insertion.
+          # Acceptable values are:
+          # - "PLACEMENT_TAG_STANDARD"
+          # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_IFRAME_ILAYER"
+          # - "PLACEMENT_TAG_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
+          # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
+          # - "PLACEMENT_TAG_CLICK_COMMANDS"
+          # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
+          # - "PLACEMENT_TAG_TRACKING"
+          # - "PLACEMENT_TAG_TRACKING_IFRAME"
+          # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
+        "A String",
+      ],
+      "paymentApproved": True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
+      "tagSetting": { # Tag Settings # Tag settings for this placement.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "contentCategoryId": "A String", # ID of the content category assigned to this placement.
+      "externalId": "A String", # External ID for this placement.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+      "sslRequired": True or False, # Whether creatives assigned to this placement must be SSL-compliant.
+      "status": "A String", # Third-party placement status.
+      "campaignIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "primary": True or False, # 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.
+      "placementGroupId": "A String", # ID of this placement's group, if applicable.
+      "createInfo": { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "siteId": "A String", # 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.
+      "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "compatibility": "A String", # 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.
+      "placementStrategyId": "A String", # ID of the placement strategy assigned to this placement.
+      "placementGroupIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "kind": "dfareporting#placement", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".
+      "subaccountId": "A String", # Subaccount ID of this placement. This field can be left blank.
+      "name": "A String", # Name of this placement.This is a required field and must be less than 256 characters long.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this placement.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
+        "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+      },
+      "pricingSchedule": { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
+        "startDate": "A String", # 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.
+        "endDate": "A String", # 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.
+        "flighted": True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
+        "disregardOverdelivery": True or False, # Whether cap costs are ignored by ad serving.
+        "capCostOption": "A String", # Placement cap cost option.
+        "pricingPeriods": [ # Pricing periods for this placement.
+          { # Pricing Period
+            "units": "A String", # Units of this pricing period.
+            "rateOrCostNanos": "A String", # Rate or cost of this pricing period.
+            "startDate": "A String", # 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.
+            "endDate": "A String", # 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.
+            "pricingComment": "A String", # Comments for this pricing period.
+          },
+        ],
+        "pricingType": "A String", # Placement pricing type. This field is required on insertion.
+        "testingStartDate": "A String", # 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.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
+      },
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.platformTypes.html b/docs/dyn/dfareporting_v2_4.platformTypes.html new file mode 100644 index 00000000000..525021793b5 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.platformTypes.html @@ -0,0 +1,124 @@ + + + +

DCM/DFA Reporting And Trafficking API . platformTypes

+

Instance Methods

+

+ get(profileId, id)

+

Gets one platform type by ID.

+

+ list(profileId)

+

Retrieves a list of platform types.

+

Method Details

+
+ get(profileId, id) +
Gets one platform type by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Platform type ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about a platform type that can be targeted by ads.
+    "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+    "id": "A String", # ID of this platform type.
+    "name": "A String", # Name of this platform type.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of platform types.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Platform Type List Response
+    "kind": "dfareporting#platformTypesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformTypesListResponse".
+    "platformTypes": [ # Platform type collection.
+      { # Contains information about a platform type that can be targeted by ads.
+        "kind": "dfareporting#platformType", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#platformType".
+        "id": "A String", # ID of this platform type.
+        "name": "A String", # Name of this platform type.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.postalCodes.html b/docs/dyn/dfareporting_v2_4.postalCodes.html new file mode 100644 index 00000000000..90efd3f9131 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.postalCodes.html @@ -0,0 +1,128 @@ + + + +

DCM/DFA Reporting And Trafficking API . postalCodes

+

Instance Methods

+

+ get(profileId, code)

+

Gets one postal code by ID.

+

+ list(profileId)

+

Retrieves a list of postal codes.

+

Method Details

+
+ get(profileId, code) +
Gets one postal code by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  code: string, Postal code ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains information about a postal code that can be targeted by ads.
+    "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+    "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+    "code": "A String", # Postal code. This is equivalent to the id field.
+    "id": "A String", # ID of this postal code.
+    "countryCode": "A String", # Country code of the country to which this postal code belongs.
+  }
+
+ +
+ list(profileId) +
Retrieves a list of postal codes.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Postal Code List Response
+    "kind": "dfareporting#postalCodesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCodesListResponse".
+    "postalCodes": [ # Postal code collection.
+      { # Contains information about a postal code that can be targeted by ads.
+        "countryDartId": "A String", # DART ID of the country to which this postal code belongs.
+        "kind": "dfareporting#postalCode", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#postalCode".
+        "code": "A String", # Postal code. This is equivalent to the id field.
+        "id": "A String", # ID of this postal code.
+        "countryCode": "A String", # Country code of the country to which this postal code belongs.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.projects.html b/docs/dyn/dfareporting_v2_4.projects.html new file mode 100644 index 00000000000..8ea5382cb72 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.projects.html @@ -0,0 +1,195 @@ + + + +

DCM/DFA Reporting And Trafficking API . projects

+

Instance Methods

+

+ get(profileId, id)

+

Gets one project by ID.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None)

+

Retrieves a list of projects, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, id) +
Gets one project by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Project ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DoubleClick Planning project.
+    "startDate": "A String", # Start date of the project.
+    "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
+    "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
+    "endDate": "A String", # End date of the project.
+    "name": "A String", # Name of this project.
+    "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
+    "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
+    "clientBillingCode": "A String", # Client billing code of this project.
+    "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
+      "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+    },
+    "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
+    "budget": "A String", # 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.
+    "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
+    "advertiserId": "A String", # Advertiser ID of this project.
+    "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
+    "overview": "A String", # Overview of this project.
+    "audienceAgeGroup": "A String", # Audience age group of this project.
+    "subaccountId": "A String", # Subaccount ID of this project.
+    "audienceGender": "A String", # Audience gender of this project.
+    "id": "A String", # ID of this project. This is a read-only, auto-generated field.
+    "clientName": "A String", # Name of the project client.
+    "accountId": "A String", # Account ID of this project.
+  }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, advertiserIds=None, ids=None, maxResults=None, sortOrder=None) +
Retrieves a list of projects, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  advertiserIds: string, Select only projects with these advertiser IDs. (repeated)
+  ids: string, Select only projects with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Project List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#projectsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#projectsListResponse".
+    "projects": [ # Project collection.
+      { # Contains properties of a DoubleClick Planning project.
+        "startDate": "A String", # Start date of the project.
+        "kind": "dfareporting#project", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#project".
+        "targetConversions": "A String", # Number of conversions that the advertiser is targeting.
+        "endDate": "A String", # End date of the project.
+        "name": "A String", # Name of this project.
+        "targetCpmNanos": "A String", # CPM that the advertiser is targeting.
+        "targetCpcNanos": "A String", # CPC that the advertiser is targeting.
+        "clientBillingCode": "A String", # Client billing code of this project.
+        "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this project.
+          "time": "A String", # Timestamp of the last change in milliseconds since epoch.
+        },
+        "targetClicks": "A String", # Number of clicks that the advertiser is targeting.
+        "budget": "A String", # 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.
+        "targetCpaNanos": "A String", # CPA that the advertiser is targeting.
+        "advertiserId": "A String", # Advertiser ID of this project.
+        "targetImpressions": "A String", # Number of impressions that the advertiser is targeting.
+        "overview": "A String", # Overview of this project.
+        "audienceAgeGroup": "A String", # Audience age group of this project.
+        "subaccountId": "A String", # Subaccount ID of this project.
+        "audienceGender": "A String", # Audience gender of this project.
+        "id": "A String", # ID of this project. This is a read-only, auto-generated field.
+        "clientName": "A String", # Name of the project client.
+        "accountId": "A String", # Account ID of this project.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.regions.html b/docs/dyn/dfareporting_v2_4.regions.html new file mode 100644 index 00000000000..6909828abd5 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.regions.html @@ -0,0 +1,106 @@ + + + +

DCM/DFA Reporting And Trafficking API . regions

+

Instance Methods

+

+ list(profileId)

+

Retrieves a list of regions.

+

Method Details

+
+ list(profileId) +
Retrieves a list of regions.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # Region List Response
+    "regions": [ # Region collection.
+      { # Contains information about a region that can be targeted by ads.
+        "kind": "dfareporting#region", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#region".
+        "countryDartId": "A String", # DART ID of the country to which this region belongs.
+        "name": "A String", # Name of this region.
+        "countryCode": "A String", # Country code of the country to which this region belongs.
+        "regionCode": "A String", # Region code.
+        "dartId": "A String", # DART ID of this region.
+      },
+    ],
+    "kind": "dfareporting#regionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#regionsListResponse".
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.remarketingListShares.html b/docs/dyn/dfareporting_v2_4.remarketingListShares.html new file mode 100644 index 00000000000..2c7adf84c8d --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.remarketingListShares.html @@ -0,0 +1,183 @@ + + + +

DCM/DFA Reporting And Trafficking API . remarketingListShares

+

Instance Methods

+

+ get(profileId, remarketingListId)

+

Gets one remarketing list share by remarketing list ID.

+

+ patch(profileId, remarketingListId, body)

+

Updates an existing remarketing list share. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing remarketing list share.

+

Method Details

+
+ get(profileId, remarketingListId) +
Gets one remarketing list share by remarketing list ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  remarketingListId: string, Remarketing list ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+        "A String",
+      ],
+      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+        "A String",
+      ],
+    }
+
+ +
+ patch(profileId, remarketingListId, body) +
Updates an existing remarketing list share. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  remarketingListId: string, Remarketing list ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+      "A String",
+    ],
+    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+      "A String",
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+        "A String",
+      ],
+      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+        "A String",
+      ],
+    }
+
+ +
+ update(profileId, body) +
Updates an existing remarketing list share.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+      "A String",
+    ],
+    "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+    "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+    "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+      "A String",
+    ],
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "sharedAdvertiserIds": [ # Advertisers that the remarketing list is shared with.
+        "A String",
+      ],
+      "kind": "dfareporting#remarketingListShare", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListShare".
+      "remarketingListId": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "sharedAccountIds": [ # Accounts that the remarketing list is shared with.
+        "A String",
+      ],
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.remarketingLists.html b/docs/dyn/dfareporting_v2_4.remarketingLists.html new file mode 100644 index 00000000000..cc478e5d360 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.remarketingLists.html @@ -0,0 +1,532 @@ + + + +

DCM/DFA Reporting And Trafficking API . remarketingLists

+

Instance Methods

+

+ get(profileId, id)

+

Gets one remarketing list by ID.

+

+ insert(profileId, body)

+

Inserts a new remarketing list.

+

+ list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None)

+

Retrieves a list of remarketing lists, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing remarketing list. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing remarketing list.

+

Method Details

+
+ get(profileId, id) +
Gets one remarketing list by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Remarketing list ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+        "listPopulationClauses": [ # 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.
+          { # A group clause made up of list population terms representing constraints joined by ORs.
+            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+              { # Remarketing List Population Rule Term.
+                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+                "contains": True or False, # 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": True or False, # 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.
+                "value": "A String", # 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": "A String", # 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.
+                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+                "type": "A String", # 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.
+                "variableName": "A String", # 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.
+              },
+            ],
+          },
+        ],
+      },
+      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+      "description": "A String", # Remarketing list description.
+      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+      "listSource": "A String", # Product from which this remarketing list was originated.
+      "active": True or False, # Whether this remarketing list is active.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new remarketing list.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+      "listPopulationClauses": [ # 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.
+        { # A group clause made up of list population terms representing constraints joined by ORs.
+          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+            { # Remarketing List Population Rule Term.
+              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+              "contains": True or False, # 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": True or False, # 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.
+              "value": "A String", # 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": "A String", # 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.
+              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+              "type": "A String", # 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.
+              "variableName": "A String", # 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.
+            },
+          ],
+        },
+      ],
+    },
+    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    "description": "A String", # Remarketing list description.
+    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+    "listSource": "A String", # Product from which this remarketing list was originated.
+    "active": True or False, # Whether this remarketing list is active.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+        "listPopulationClauses": [ # 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.
+          { # A group clause made up of list population terms representing constraints joined by ORs.
+            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+              { # Remarketing List Population Rule Term.
+                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+                "contains": True or False, # 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": True or False, # 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.
+                "value": "A String", # 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": "A String", # 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.
+                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+                "type": "A String", # 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.
+                "variableName": "A String", # 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.
+              },
+            ],
+          },
+        ],
+      },
+      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+      "description": "A String", # Remarketing list description.
+      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+      "listSource": "A String", # Product from which this remarketing list was originated.
+      "active": True or False, # Whether this remarketing list is active.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    }
+
+ +
+ list(profileId, advertiserId, name=None, pageToken=None, sortField=None, floodlightActivityId=None, maxResults=None, active=None, sortOrder=None) +
Retrieves a list of remarketing lists, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  advertiserId: string, Select only remarketing lists owned by this advertiser. (required)
+  name: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  floodlightActivityId: string, Select only remarketing lists that have this floodlight activity ID.
+  maxResults: integer, Maximum number of results to return.
+  active: boolean, Select only active or only inactive remarketing lists.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Remarketing list response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "remarketingLists": [ # Remarketing list collection.
+      { # 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.
+          "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+            "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+            "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+            "listPopulationClauses": [ # 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.
+              { # A group clause made up of list population terms representing constraints joined by ORs.
+                "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+                  { # Remarketing List Population Rule Term.
+                    "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+                    "contains": True or False, # 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": True or False, # 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.
+                    "value": "A String", # 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": "A String", # 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.
+                    "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+                    "type": "A String", # 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.
+                    "variableName": "A String", # 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.
+                  },
+                ],
+              },
+            ],
+          },
+          "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+          "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+          "description": "A String", # Remarketing list description.
+          "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+          "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+          "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+          "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+          "listSource": "A String", # Product from which this remarketing list was originated.
+          "active": True or False, # Whether this remarketing list is active.
+          "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+        },
+    ],
+    "kind": "dfareporting#remarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse".
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing remarketing list. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Remarketing list ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+      "listPopulationClauses": [ # 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.
+        { # A group clause made up of list population terms representing constraints joined by ORs.
+          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+            { # Remarketing List Population Rule Term.
+              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+              "contains": True or False, # 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": True or False, # 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.
+              "value": "A String", # 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": "A String", # 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.
+              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+              "type": "A String", # 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.
+              "variableName": "A String", # 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.
+            },
+          ],
+        },
+      ],
+    },
+    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    "description": "A String", # Remarketing list description.
+    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+    "listSource": "A String", # Product from which this remarketing list was originated.
+    "active": True or False, # Whether this remarketing list is active.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+        "listPopulationClauses": [ # 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.
+          { # A group clause made up of list population terms representing constraints joined by ORs.
+            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+              { # Remarketing List Population Rule Term.
+                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+                "contains": True or False, # 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": True or False, # 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.
+                "value": "A String", # 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": "A String", # 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.
+                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+                "type": "A String", # 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.
+                "variableName": "A String", # 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.
+              },
+            ],
+          },
+        ],
+      },
+      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+      "description": "A String", # Remarketing list description.
+      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+      "listSource": "A String", # Product from which this remarketing list was originated.
+      "active": True or False, # Whether this remarketing list is active.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing remarketing list.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # 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.
+    "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+      "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+      "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+      "listPopulationClauses": [ # 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.
+        { # A group clause made up of list population terms representing constraints joined by ORs.
+          "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+            { # Remarketing List Population Rule Term.
+              "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+              "contains": True or False, # 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": True or False, # 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.
+              "value": "A String", # 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": "A String", # 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.
+              "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+              "type": "A String", # 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.
+              "variableName": "A String", # 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.
+            },
+          ],
+        },
+      ],
+    },
+    "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    "description": "A String", # Remarketing list description.
+    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+    "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+    "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+    "listSource": "A String", # Product from which this remarketing list was originated.
+    "active": True or False, # Whether this remarketing list is active.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # 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.
+      "listPopulationRule": { # Remarketing List Population Rule. # Rule used to populate the remarketing list with users.
+        "floodlightActivityName": "A String", # Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.
+        "floodlightActivityId": "A String", # Floodlight activity ID associated with this rule. This field can be left blank.
+        "listPopulationClauses": [ # 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.
+          { # A group clause made up of list population terms representing constraints joined by ORs.
+            "terms": [ # Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.
+              { # Remarketing List Population Rule Term.
+                "remarketingListId": "A String", # ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.
+                "contains": True or False, # 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": True or False, # 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.
+                "value": "A String", # 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": "A String", # 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.
+                "operator": "A String", # Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.
+                "type": "A String", # 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.
+                "variableName": "A String", # 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.
+              },
+            ],
+          },
+        ],
+      },
+      "kind": "dfareporting#remarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList".
+      "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+      "description": "A String", # Remarketing list description.
+      "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+      "lifeSpan": "A String", # Number of days that a user should remain in the remarketing list without an impression.
+      "name": "A String", # Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.
+      "advertiserId": "A String", # Dimension value for the advertiser ID that owns this remarketing list. This is a required field.
+      "listSource": "A String", # Product from which this remarketing list was originated.
+      "active": True or False, # Whether this remarketing list is active.
+      "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "id": "A String", # Remarketing list ID. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.reports.compatibleFields.html b/docs/dyn/dfareporting_v2_4.reports.compatibleFields.html new file mode 100644 index 00000000000..891a6abc433 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.reports.compatibleFields.html @@ -0,0 +1,551 @@ + + + +

DCM/DFA Reporting And Trafficking API . reports . compatibleFields

+

Instance Methods

+

+ query(profileId, body)

+

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.

+

Method Details

+
+ query(profileId, body) +
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.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Report resource.
+    "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+      "conversionDimensions": [ # The list of conversion dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "reportProperties": { # The properties of the report.
+        "clicksLookbackWindow": 42, # 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.
+        "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+        "impressionsLookbackWindow": 42, # 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.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+        "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+        "maximumClickInteractions": 42, # 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.
+        "maximumImpressionInteractions": 42, # 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.
+      },
+      "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+    },
+    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+    "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+    "name": "A String", # The name of the report.
+    "schedule": { # 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".
+      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+      "runsOnDayOfMonth": "A String", # 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.
+          # Example: 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.
+      "every": 42, # 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".
+      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+      "repeats": "A String", # The interval for which the report is repeated. Note:
+          # - "DAILY" also requires field "every" to be set.
+          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+        "A String",
+      ],
+    },
+    "format": "A String", # 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.
+    "ownerProfileId": "A String", # The user profile id of the owner of this report.
+    "reachCriteria": { # The report criteria for a report of type "REACH".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+        "A String",
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+      "enableAllDimensionCombinations": True or False, # 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.
+    },
+    "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reportProperties": { # The properties of the report.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+      },
+    },
+    "fileName": "A String", # The filename used when generating report files for this report.
+    "delivery": { # The report's email delivery settings.
+      "message": "A String", # The message to be sent with each email.
+      "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+      "recipients": [ # The list of recipients to which to email the report.
+        { # Represents a recipient.
+          "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+          "deliveryType": "A String", # The delivery type for the recipient.
+          "email": "A String", # The email address of the recipient.
+        },
+      ],
+      "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+    },
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "criteria": { # The report criteria for a report of type "STANDARD".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of standard dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range for which this report should be run.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+    },
+    "id": "A String", # The unique ID identifying this report resource.
+    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+    "type": "A String", # The type of the report.
+    "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+      "breakdown": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+        "A String",
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+      "dimension": "A String", # The dimension option.
+    },
+    "accountId": "A String", # The account ID to which this report belongs.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a response to the queryCompatibleFields method.
+    "kind": "dfareporting#compatibleFields", # The kind of resource this is, in this case dfareporting#compatibleFields.
+    "reachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "REACH". # Contains items that are compatible to be selected for a report of type "REACH".
+      "kind": "dfareporting#reachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#reachReportCompatibleFields.
+      "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "reachByFrequencyMetrics": [ # Metrics which are compatible to be selected in the "reachByFrequencyMetricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+    },
+    "pathToConversionReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "PATH_TO_CONVERSION". # Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION".
+      "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "perInteractionDimensions": [ # Per-interaction dimensions which are compatible to be selected in the "perInteractionDimensions" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "kind": "dfareporting#pathToConversionReportCompatibleFields", # The kind of resource this is, in this case dfareporting#pathToConversionReportCompatibleFields.
+      "conversionDimensions": [ # Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "customFloodlightVariables": [ # Custom floodlight variables which are compatible to be selected in the "customFloodlightVariables" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+    },
+    "crossDimensionReachReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". # Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH".
+      "breakdown": [ # Dimensions which are compatible to be selected in the "breakdown" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "kind": "dfareporting#crossDimensionReachReportCompatibleFields", # The kind of resource this is, in this case dfareporting#crossDimensionReachReportCompatibleFields.
+      "overlapMetrics": [ # Metrics which are compatible to be selected in the "overlapMetricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+    },
+    "floodlightReportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "FlOODLIGHT". # Contains items that are compatible to be selected for a report of type "FLOODLIGHT".
+      "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "kind": "dfareporting#floodlightReportCompatibleFields", # The kind of resource this is, in this case dfareporting#floodlightReportCompatibleFields.
+      "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+    },
+    "reportCompatibleFields": { # Represents fields that are compatible to be selected for a report of type "STANDARD". # Contains items that are compatible to be selected for a report of type "STANDARD".
+      "metrics": [ # Metrics which are compatible to be selected in the "metricNames" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "kind": "dfareporting#reportCompatibleFields", # The kind of resource this is, in this case dfareporting#reportCompatibleFields.
+      "pivotedActivityMetrics": [ # Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report.
+        { # Represents a metric.
+          "kind": "dfareporting#metric", # The kind of resource this is, in this case dfareporting#metric.
+          "name": "A String", # The metric name, e.g. dfa:impressions
+        },
+      ],
+      "dimensionFilters": [ # Dimensions which are compatible to be selected in the "dimensionFilters" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+      "dimensions": [ # Dimensions which are compatible to be selected in the "dimensions" section of the report.
+        { # Represents a dimension.
+          "kind": "dfareporting#dimension", # The kind of resource this is, in this case dfareporting#dimension.
+          "name": "A String", # The dimension name, e.g. dfa:advertiser
+        },
+      ],
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.reports.files.html b/docs/dyn/dfareporting_v2_4.reports.files.html new file mode 100644 index 00000000000..9e07b242a2a --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.reports.files.html @@ -0,0 +1,203 @@ + + + +

DCM/DFA Reporting And Trafficking API . reports . files

+

Instance Methods

+

+ get(profileId, reportId, fileId)

+

Retrieves a report file.

+

+ get_media(profileId, reportId, fileId)

+

Retrieves a report file.

+

+ list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)

+

Lists files for a report.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, reportId, fileId) +
Retrieves a report file.
+
+Args:
+  profileId: string, The DFA profile ID. (required)
+  reportId: string, The ID of the report. (required)
+  fileId: string, The ID of the report file. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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".
+    "status": "A String", # The status of the report file.
+    "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+    "format": "A String", # The output format of the report. Only available once the file is available.
+    "dateRange": { # Represents a date range. # 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.
+      "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+      "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+    },
+    "fileName": "A String", # The filename of the file.
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "reportId": "A String", # The ID of the report this file was generated from.
+    "urls": { # The URLs where the completed report file can be downloaded.
+      "browserUrl": "A String", # The URL for downloading the report data through a browser.
+      "apiUrl": "A String", # The URL for downloading the report data through the API.
+    },
+    "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+    "id": "A String", # The unique ID of this report file.
+  }
+
+ +
+ get_media(profileId, reportId, fileId) +
Retrieves a report file.
+
+Args:
+  profileId: string, The DFA profile ID. (required)
+  reportId: string, The ID of the report. (required)
+  fileId: string, The ID of the report file. (required)
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None) +
Lists files for a report.
+
+Args:
+  profileId: string, The DFA profile ID. (required)
+  reportId: string, The ID of the parent report. (required)
+  pageToken: string, The value of the nextToken from the previous result page.
+  sortField: string, The field by which to sort the list.
+    Allowed values
+      ID - Sort by file ID.
+      LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is 'DESCENDING'.
+    Allowed values
+      ASCENDING - Ascending order.
+      DESCENDING - Descending order.
+
+Returns:
+  An object of the form:
+
+    { # Represents the list of File resources.
+    "nextPageToken": "A String", # 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.
+    "items": [ # The files returned in this response.
+      { # 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".
+        "status": "A String", # The status of the report file.
+        "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+        "format": "A String", # The output format of the report. Only available once the file is available.
+        "dateRange": { # Represents a date range. # 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.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "fileName": "A String", # The filename of the file.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "reportId": "A String", # The ID of the report this file was generated from.
+        "urls": { # The URLs where the completed report file can be downloaded.
+          "browserUrl": "A String", # The URL for downloading the report data through a browser.
+          "apiUrl": "A String", # The URL for downloading the report data through the API.
+        },
+        "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+        "id": "A String", # The unique ID of this report file.
+      },
+    ],
+    "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
+    "etag": "A String", # The eTag of this response for caching purposes.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.reports.html b/docs/dyn/dfareporting_v2_4.reports.html new file mode 100644 index 00000000000..5b1e347ceba --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.reports.html @@ -0,0 +1,2795 @@ + + + +

DCM/DFA Reporting And Trafficking API . reports

+

Instance Methods

+

+ compatibleFields() +

+

Returns the compatibleFields Resource.

+ +

+ files() +

+

Returns the files Resource.

+ +

+ delete(profileId, reportId)

+

Deletes a report by its ID.

+

+ get(profileId, reportId)

+

Retrieves a report by its ID.

+

+ insert(profileId, body)

+

Creates a report.

+

+ list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)

+

Retrieves list of reports.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, reportId, body)

+

Updates a report. This method supports patch semantics.

+

+ run(profileId, reportId, synchronous=None)

+

Runs a report.

+

+ update(profileId, reportId, body)

+

Updates a report.

+

Method Details

+
+ delete(profileId, reportId) +
Deletes a report by its ID.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  reportId: string, The ID of the report. (required)
+
+
+ +
+ get(profileId, reportId) +
Retrieves a report by its ID.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  reportId: string, The ID of the report. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a Report resource.
+      "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+        "conversionDimensions": [ # The list of conversion dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "reportProperties": { # The properties of the report.
+          "clicksLookbackWindow": 42, # 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.
+          "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+          "impressionsLookbackWindow": 42, # 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.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+          "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+          "maximumClickInteractions": 42, # 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.
+          "maximumImpressionInteractions": 42, # 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.
+        },
+        "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+      },
+      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+      "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+      "name": "A String", # The name of the report.
+      "schedule": { # 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".
+        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+        "runsOnDayOfMonth": "A String", # 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.
+            # Example: 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.
+        "every": 42, # 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".
+        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+        "repeats": "A String", # The interval for which the report is repeated. Note:
+            # - "DAILY" also requires field "every" to be set.
+            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+          "A String",
+        ],
+      },
+      "format": "A String", # 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.
+      "ownerProfileId": "A String", # The user profile id of the owner of this report.
+      "reachCriteria": { # The report criteria for a report of type "REACH".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+          "A String",
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+        "enableAllDimensionCombinations": True or False, # 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.
+      },
+      "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reportProperties": { # The properties of the report.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+        },
+      },
+      "fileName": "A String", # The filename used when generating report files for this report.
+      "delivery": { # The report's email delivery settings.
+        "message": "A String", # The message to be sent with each email.
+        "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+        "recipients": [ # The list of recipients to which to email the report.
+          { # Represents a recipient.
+            "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+            "deliveryType": "A String", # The delivery type for the recipient.
+            "email": "A String", # The email address of the recipient.
+          },
+        ],
+        "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+      },
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "criteria": { # The report criteria for a report of type "STANDARD".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of standard dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range for which this report should be run.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+      },
+      "id": "A String", # The unique ID identifying this report resource.
+      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+      "type": "A String", # The type of the report.
+      "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+        "breakdown": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+          "A String",
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+        "dimension": "A String", # The dimension option.
+      },
+      "accountId": "A String", # The account ID to which this report belongs.
+    }
+
+ +
+ insert(profileId, body) +
Creates a report.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Report resource.
+    "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+      "conversionDimensions": [ # The list of conversion dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "reportProperties": { # The properties of the report.
+        "clicksLookbackWindow": 42, # 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.
+        "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+        "impressionsLookbackWindow": 42, # 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.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+        "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+        "maximumClickInteractions": 42, # 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.
+        "maximumImpressionInteractions": 42, # 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.
+      },
+      "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+    },
+    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+    "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+    "name": "A String", # The name of the report.
+    "schedule": { # 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".
+      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+      "runsOnDayOfMonth": "A String", # 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.
+          # Example: 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.
+      "every": 42, # 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".
+      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+      "repeats": "A String", # The interval for which the report is repeated. Note:
+          # - "DAILY" also requires field "every" to be set.
+          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+        "A String",
+      ],
+    },
+    "format": "A String", # 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.
+    "ownerProfileId": "A String", # The user profile id of the owner of this report.
+    "reachCriteria": { # The report criteria for a report of type "REACH".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+        "A String",
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+      "enableAllDimensionCombinations": True or False, # 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.
+    },
+    "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reportProperties": { # The properties of the report.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+      },
+    },
+    "fileName": "A String", # The filename used when generating report files for this report.
+    "delivery": { # The report's email delivery settings.
+      "message": "A String", # The message to be sent with each email.
+      "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+      "recipients": [ # The list of recipients to which to email the report.
+        { # Represents a recipient.
+          "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+          "deliveryType": "A String", # The delivery type for the recipient.
+          "email": "A String", # The email address of the recipient.
+        },
+      ],
+      "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+    },
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "criteria": { # The report criteria for a report of type "STANDARD".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of standard dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range for which this report should be run.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+    },
+    "id": "A String", # The unique ID identifying this report resource.
+    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+    "type": "A String", # The type of the report.
+    "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+      "breakdown": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+        "A String",
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+      "dimension": "A String", # The dimension option.
+    },
+    "accountId": "A String", # The account ID to which this report belongs.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a Report resource.
+      "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+        "conversionDimensions": [ # The list of conversion dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "reportProperties": { # The properties of the report.
+          "clicksLookbackWindow": 42, # 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.
+          "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+          "impressionsLookbackWindow": 42, # 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.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+          "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+          "maximumClickInteractions": 42, # 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.
+          "maximumImpressionInteractions": 42, # 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.
+        },
+        "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+      },
+      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+      "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+      "name": "A String", # The name of the report.
+      "schedule": { # 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".
+        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+        "runsOnDayOfMonth": "A String", # 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.
+            # Example: 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.
+        "every": 42, # 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".
+        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+        "repeats": "A String", # The interval for which the report is repeated. Note:
+            # - "DAILY" also requires field "every" to be set.
+            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+          "A String",
+        ],
+      },
+      "format": "A String", # 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.
+      "ownerProfileId": "A String", # The user profile id of the owner of this report.
+      "reachCriteria": { # The report criteria for a report of type "REACH".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+          "A String",
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+        "enableAllDimensionCombinations": True or False, # 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.
+      },
+      "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reportProperties": { # The properties of the report.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+        },
+      },
+      "fileName": "A String", # The filename used when generating report files for this report.
+      "delivery": { # The report's email delivery settings.
+        "message": "A String", # The message to be sent with each email.
+        "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+        "recipients": [ # The list of recipients to which to email the report.
+          { # Represents a recipient.
+            "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+            "deliveryType": "A String", # The delivery type for the recipient.
+            "email": "A String", # The email address of the recipient.
+          },
+        ],
+        "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+      },
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "criteria": { # The report criteria for a report of type "STANDARD".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of standard dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range for which this report should be run.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+      },
+      "id": "A String", # The unique ID identifying this report resource.
+      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+      "type": "A String", # The type of the report.
+      "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+        "breakdown": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+          "A String",
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+        "dimension": "A String", # The dimension option.
+      },
+      "accountId": "A String", # The account ID to which this report belongs.
+    }
+
+ +
+ list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None) +
Retrieves list of reports.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  pageToken: string, The value of the nextToken from the previous result page.
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is 'DESCENDING'.
+    Allowed values
+      ASCENDING - Ascending order.
+      DESCENDING - Descending order.
+  sortField: string, The field by which to sort the list.
+    Allowed values
+      ID - Sort by report ID.
+      LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
+      NAME - Sort by name of reports.
+  scope: string, The scope that defines which results are returned, default is 'MINE'.
+    Allowed values
+      ALL - All reports in account.
+      MINE - My reports.
+
+Returns:
+  An object of the form:
+
+    { # Represents the list of reports.
+    "nextPageToken": "A String", # 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.
+    "items": [ # The reports returned in this response.
+      { # Represents a Report resource.
+          "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+            "conversionDimensions": [ # The list of conversion dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "metricNames": [ # The list of names of metrics the report should include.
+              "A String",
+            ],
+            "dateRange": { # Represents a date range. # The date range this report should be run for.
+              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+            },
+            "reportProperties": { # The properties of the report.
+              "clicksLookbackWindow": 42, # 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.
+              "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+              "impressionsLookbackWindow": 42, # 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.
+              "includeUnattributedIPConversions": True or False, # 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.
+              "includeUnattributedCookieConversions": True or False, # 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.
+              "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+              "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+              "maximumClickInteractions": 42, # 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.
+              "maximumImpressionInteractions": 42, # 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.
+            },
+            "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "customRichMediaEvents": [ # The list of custom rich media events to include.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+          },
+          "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+          "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+          "name": "A String", # The name of the report.
+          "schedule": { # 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".
+            "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+            "runsOnDayOfMonth": "A String", # 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.
+                # Example: 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.
+            "every": 42, # 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".
+            "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+            "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+            "repeats": "A String", # The interval for which the report is repeated. Note:
+                # - "DAILY" also requires field "every" to be set.
+                # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+                # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+            "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+              "A String",
+            ],
+          },
+          "format": "A String", # 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.
+          "ownerProfileId": "A String", # The user profile id of the owner of this report.
+          "reachCriteria": { # The report criteria for a report of type "REACH".
+            "activities": { # Represents an activity group. # Activity group.
+              "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+              "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+                { # Represents a DimensionValue resource.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+              ],
+              "metricNames": [ # List of names of floodlight activity metrics.
+                "A String",
+              ],
+            },
+            "dimensions": [ # The list of dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "metricNames": [ # The list of names of metrics the report should include.
+              "A String",
+            ],
+            "dateRange": { # Represents a date range. # The date range this report should be run for.
+              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+            },
+            "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+                # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+              "A String",
+            ],
+            "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+              "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+              "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+                { # Represents a DimensionValue resource.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+              ],
+            },
+            "enableAllDimensionCombinations": True or False, # 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.
+          },
+          "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+            "dimensions": [ # The list of dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "metricNames": [ # The list of names of metrics the report should include.
+              "A String",
+            ],
+            "dateRange": { # Represents a date range. # The date range this report should be run for.
+              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+            },
+            "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+                # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+            "customRichMediaEvents": [ # The list of custom rich media events to include.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "reportProperties": { # The properties of the report.
+              "includeUnattributedIPConversions": True or False, # 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.
+              "includeUnattributedCookieConversions": True or False, # 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.
+              "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+            },
+          },
+          "fileName": "A String", # The filename used when generating report files for this report.
+          "delivery": { # The report's email delivery settings.
+            "message": "A String", # The message to be sent with each email.
+            "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+            "recipients": [ # The list of recipients to which to email the report.
+              { # Represents a recipient.
+                "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+                "deliveryType": "A String", # The delivery type for the recipient.
+                "email": "A String", # The email address of the recipient.
+              },
+            ],
+            "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+          },
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "criteria": { # The report criteria for a report of type "STANDARD".
+            "activities": { # Represents an activity group. # Activity group.
+              "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+              "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+                { # Represents a DimensionValue resource.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+              ],
+              "metricNames": [ # List of names of floodlight activity metrics.
+                "A String",
+              ],
+            },
+            "dimensions": [ # The list of standard dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "metricNames": [ # The list of names of metrics the report should include.
+              "A String",
+            ],
+            "dateRange": { # Represents a date range. # The date range for which this report should be run.
+              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+            },
+            "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+                # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+              "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+              "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+                { # Represents a DimensionValue resource.
+                  "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                  "value": "A String", # The value of the dimension.
+                  "dimensionName": "A String", # The name of the dimension.
+                  "etag": "A String", # The eTag of this response for caching purposes.
+                  "matchType": "A String", # 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.
+                  "id": "A String", # The ID associated with the value if available.
+                },
+              ],
+            },
+          },
+          "id": "A String", # The unique ID identifying this report resource.
+          "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+          "type": "A String", # The type of the report.
+          "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+            "breakdown": [ # The list of dimensions the report should include.
+              { # Represents a sorted dimension.
+                "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+                "name": "A String", # The name of the dimension.
+                "sortOrder": "A String", # An optional sort order for the dimension column.
+              },
+            ],
+            "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+              "A String",
+            ],
+            "metricNames": [ # The list of names of metrics the report should include.
+              "A String",
+            ],
+            "dateRange": { # Represents a date range. # The date range this report should be run for.
+              "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+              "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+              "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+            },
+            "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+              { # Represents a DimensionValue resource.
+                "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+                "value": "A String", # The value of the dimension.
+                "dimensionName": "A String", # The name of the dimension.
+                "etag": "A String", # The eTag of this response for caching purposes.
+                "matchType": "A String", # 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.
+                "id": "A String", # The ID associated with the value if available.
+              },
+            ],
+            "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+            "dimension": "A String", # The dimension option.
+          },
+          "accountId": "A String", # The account ID to which this report belongs.
+        },
+    ],
+    "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
+    "etag": "A String", # The eTag of this response for caching purposes.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, reportId, body) +
Updates a report. This method supports patch semantics.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  reportId: string, The ID of the report. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Report resource.
+    "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+      "conversionDimensions": [ # The list of conversion dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "reportProperties": { # The properties of the report.
+        "clicksLookbackWindow": 42, # 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.
+        "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+        "impressionsLookbackWindow": 42, # 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.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+        "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+        "maximumClickInteractions": 42, # 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.
+        "maximumImpressionInteractions": 42, # 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.
+      },
+      "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+    },
+    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+    "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+    "name": "A String", # The name of the report.
+    "schedule": { # 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".
+      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+      "runsOnDayOfMonth": "A String", # 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.
+          # Example: 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.
+      "every": 42, # 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".
+      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+      "repeats": "A String", # The interval for which the report is repeated. Note:
+          # - "DAILY" also requires field "every" to be set.
+          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+        "A String",
+      ],
+    },
+    "format": "A String", # 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.
+    "ownerProfileId": "A String", # The user profile id of the owner of this report.
+    "reachCriteria": { # The report criteria for a report of type "REACH".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+        "A String",
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+      "enableAllDimensionCombinations": True or False, # 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.
+    },
+    "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reportProperties": { # The properties of the report.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+      },
+    },
+    "fileName": "A String", # The filename used when generating report files for this report.
+    "delivery": { # The report's email delivery settings.
+      "message": "A String", # The message to be sent with each email.
+      "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+      "recipients": [ # The list of recipients to which to email the report.
+        { # Represents a recipient.
+          "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+          "deliveryType": "A String", # The delivery type for the recipient.
+          "email": "A String", # The email address of the recipient.
+        },
+      ],
+      "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+    },
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "criteria": { # The report criteria for a report of type "STANDARD".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of standard dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range for which this report should be run.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+    },
+    "id": "A String", # The unique ID identifying this report resource.
+    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+    "type": "A String", # The type of the report.
+    "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+      "breakdown": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+        "A String",
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+      "dimension": "A String", # The dimension option.
+    },
+    "accountId": "A String", # The account ID to which this report belongs.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a Report resource.
+      "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+        "conversionDimensions": [ # The list of conversion dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "reportProperties": { # The properties of the report.
+          "clicksLookbackWindow": 42, # 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.
+          "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+          "impressionsLookbackWindow": 42, # 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.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+          "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+          "maximumClickInteractions": 42, # 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.
+          "maximumImpressionInteractions": 42, # 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.
+        },
+        "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+      },
+      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+      "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+      "name": "A String", # The name of the report.
+      "schedule": { # 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".
+        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+        "runsOnDayOfMonth": "A String", # 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.
+            # Example: 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.
+        "every": 42, # 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".
+        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+        "repeats": "A String", # The interval for which the report is repeated. Note:
+            # - "DAILY" also requires field "every" to be set.
+            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+          "A String",
+        ],
+      },
+      "format": "A String", # 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.
+      "ownerProfileId": "A String", # The user profile id of the owner of this report.
+      "reachCriteria": { # The report criteria for a report of type "REACH".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+          "A String",
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+        "enableAllDimensionCombinations": True or False, # 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.
+      },
+      "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reportProperties": { # The properties of the report.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+        },
+      },
+      "fileName": "A String", # The filename used when generating report files for this report.
+      "delivery": { # The report's email delivery settings.
+        "message": "A String", # The message to be sent with each email.
+        "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+        "recipients": [ # The list of recipients to which to email the report.
+          { # Represents a recipient.
+            "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+            "deliveryType": "A String", # The delivery type for the recipient.
+            "email": "A String", # The email address of the recipient.
+          },
+        ],
+        "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+      },
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "criteria": { # The report criteria for a report of type "STANDARD".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of standard dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range for which this report should be run.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+      },
+      "id": "A String", # The unique ID identifying this report resource.
+      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+      "type": "A String", # The type of the report.
+      "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+        "breakdown": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+          "A String",
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+        "dimension": "A String", # The dimension option.
+      },
+      "accountId": "A String", # The account ID to which this report belongs.
+    }
+
+ +
+ run(profileId, reportId, synchronous=None) +
Runs a report.
+
+Args:
+  profileId: string, The DFA profile ID. (required)
+  reportId: string, The ID of the report. (required)
+  synchronous: boolean, If set and true, tries to run the report synchronously.
+
+Returns:
+  An object of the form:
+
+    { # 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".
+    "status": "A String", # The status of the report file.
+    "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+    "format": "A String", # The output format of the report. Only available once the file is available.
+    "dateRange": { # Represents a date range. # 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.
+      "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+      "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+      "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+    },
+    "fileName": "A String", # The filename of the file.
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "reportId": "A String", # The ID of the report this file was generated from.
+    "urls": { # The URLs where the completed report file can be downloaded.
+      "browserUrl": "A String", # The URL for downloading the report data through a browser.
+      "apiUrl": "A String", # The URL for downloading the report data through the API.
+    },
+    "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+    "id": "A String", # The unique ID of this report file.
+  }
+
+ +
+ update(profileId, reportId, body) +
Updates a report.
+
+Args:
+  profileId: string, The DFA user profile ID. (required)
+  reportId: string, The ID of the report. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Report resource.
+    "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+      "conversionDimensions": [ # The list of conversion dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "reportProperties": { # The properties of the report.
+        "clicksLookbackWindow": 42, # 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.
+        "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+        "impressionsLookbackWindow": 42, # 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.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+        "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+        "maximumClickInteractions": 42, # 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.
+        "maximumImpressionInteractions": 42, # 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.
+      },
+      "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+    },
+    "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+    "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+    "name": "A String", # The name of the report.
+    "schedule": { # 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".
+      "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+      "runsOnDayOfMonth": "A String", # 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.
+          # Example: 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.
+      "every": 42, # 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".
+      "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+      "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+      "repeats": "A String", # The interval for which the report is repeated. Note:
+          # - "DAILY" also requires field "every" to be set.
+          # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+          # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+      "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+        "A String",
+      ],
+    },
+    "format": "A String", # 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.
+    "ownerProfileId": "A String", # The user profile id of the owner of this report.
+    "reachCriteria": { # The report criteria for a report of type "REACH".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+        "A String",
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+      "enableAllDimensionCombinations": True or False, # 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.
+    },
+    "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+      "dimensions": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "customRichMediaEvents": [ # The list of custom rich media events to include.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "reportProperties": { # The properties of the report.
+        "includeUnattributedIPConversions": True or False, # 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.
+        "includeUnattributedCookieConversions": True or False, # 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.
+        "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+      },
+    },
+    "fileName": "A String", # The filename used when generating report files for this report.
+    "delivery": { # The report's email delivery settings.
+      "message": "A String", # The message to be sent with each email.
+      "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+      "recipients": [ # The list of recipients to which to email the report.
+        { # Represents a recipient.
+          "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+          "deliveryType": "A String", # The delivery type for the recipient.
+          "email": "A String", # The email address of the recipient.
+        },
+      ],
+      "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+    },
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "criteria": { # The report criteria for a report of type "STANDARD".
+      "activities": { # Represents an activity group. # Activity group.
+        "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+        "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "metricNames": [ # List of names of floodlight activity metrics.
+          "A String",
+        ],
+      },
+      "dimensions": [ # The list of standard dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range for which this report should be run.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+        "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+        "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+      },
+    },
+    "id": "A String", # The unique ID identifying this report resource.
+    "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+    "type": "A String", # The type of the report.
+    "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+      "breakdown": [ # The list of dimensions the report should include.
+        { # Represents a sorted dimension.
+          "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+          "name": "A String", # The name of the dimension.
+          "sortOrder": "A String", # An optional sort order for the dimension column.
+        },
+      ],
+      "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+        "A String",
+      ],
+      "metricNames": [ # The list of names of metrics the report should include.
+        "A String",
+      ],
+      "dateRange": { # Represents a date range. # The date range this report should be run for.
+        "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+        "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+        "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+      },
+      "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+        { # Represents a DimensionValue resource.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+      ],
+      "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+      "dimension": "A String", # The dimension option.
+    },
+    "accountId": "A String", # The account ID to which this report belongs.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a Report resource.
+      "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+        "conversionDimensions": [ # The list of conversion dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "reportProperties": { # The properties of the report.
+          "clicksLookbackWindow": 42, # 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.
+          "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+          "impressionsLookbackWindow": 42, # 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.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+          "includeAttributedIPConversions": True or False, # Deprecated: has no effect.
+          "maximumClickInteractions": 42, # 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.
+          "maximumImpressionInteractions": 42, # 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.
+        },
+        "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+      },
+      "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+      "subAccountId": "A String", # The subaccount ID to which this report belongs if applicable.
+      "name": "A String", # The name of the report.
+      "schedule": { # 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".
+        "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+        "runsOnDayOfMonth": "A String", # 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.
+            # Example: 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.
+        "every": 42, # 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".
+        "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+        "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+        "repeats": "A String", # The interval for which the report is repeated. Note:
+            # - "DAILY" also requires field "every" to be set.
+            # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set.
+            # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
+        "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+          "A String",
+        ],
+      },
+      "format": "A String", # 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.
+      "ownerProfileId": "A String", # The user profile id of the owner of this report.
+      "reachCriteria": { # The report criteria for a report of type "REACH".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reachByFrequencyMetricNames": [ # The list of names of  Reach By Frequency metrics the report should include.
+          "A String",
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+        "enableAllDimensionCombinations": True or False, # 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.
+      },
+      "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+        "dimensions": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "floodlightConfigId": { # Represents a DimensionValue resource. # 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'.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "customRichMediaEvents": [ # The list of custom rich media events to include.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "reportProperties": { # The properties of the report.
+          "includeUnattributedIPConversions": True or False, # 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.
+          "includeUnattributedCookieConversions": True or False, # 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.
+          "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+        },
+      },
+      "fileName": "A String", # The filename used when generating report files for this report.
+      "delivery": { # The report's email delivery settings.
+        "message": "A String", # The message to be sent with each email.
+        "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled.
+        "recipients": [ # The list of recipients to which to email the report.
+          { # Represents a recipient.
+            "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+            "deliveryType": "A String", # The delivery type for the recipient.
+            "email": "A String", # The email address of the recipient.
+          },
+        ],
+        "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+      },
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "criteria": { # The report criteria for a report of type "STANDARD".
+        "activities": { # Represents an activity group. # Activity group.
+          "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+          "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+          "metricNames": [ # List of names of floodlight activity metrics.
+            "A String",
+          ],
+        },
+        "dimensions": [ # The list of standard dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range for which this report should be run.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+            # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+          "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+          "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+            { # Represents a DimensionValue resource.
+              "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+              "value": "A String", # The value of the dimension.
+              "dimensionName": "A String", # The name of the dimension.
+              "etag": "A String", # The eTag of this response for caching purposes.
+              "matchType": "A String", # 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.
+              "id": "A String", # The ID associated with the value if available.
+            },
+          ],
+        },
+      },
+      "id": "A String", # The unique ID identifying this report resource.
+      "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+      "type": "A String", # The type of the report.
+      "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+        "breakdown": [ # The list of dimensions the report should include.
+          { # Represents a sorted dimension.
+            "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+            "name": "A String", # The name of the dimension.
+            "sortOrder": "A String", # An optional sort order for the dimension column.
+          },
+        ],
+        "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+          "A String",
+        ],
+        "metricNames": [ # The list of names of metrics the report should include.
+          "A String",
+        ],
+        "dateRange": { # Represents a date range. # The date range this report should be run for.
+          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
+        },
+        "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+          { # Represents a DimensionValue resource.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+        ],
+        "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+        "dimension": "A String", # The dimension option.
+      },
+      "accountId": "A String", # The account ID to which this report belongs.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.sites.html b/docs/dyn/dfareporting_v2_4.sites.html new file mode 100644 index 00000000000..010251ce1a7 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.sites.html @@ -0,0 +1,675 @@ + + + +

DCM/DFA Reporting And Trafficking API . sites

+

Instance Methods

+

+ get(profileId, id)

+

Gets one site by ID.

+

+ insert(profileId, body)

+

Inserts a new site.

+

+ list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None)

+

Retrieves a list of sites, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing site. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing site.

+

Method Details

+
+ get(profileId, id) +
Gets one site by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Site ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a site.
+      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteSettings": { # Site Settings # Site-wide settings.
+        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+          "additionalKeyValues": "A String", # 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.
+          "keywordOption": "A String", # 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.
+        },
+        "creativeSettings": { # Creative Settings # Site-wide creative settings.
+          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        },
+        "videoActiveViewOptOut": True or False, # 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.
+      },
+      "approved": True or False, # Whether this site is approved.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteContacts": [ # Site contacts.
+        { # Site Contact
+          "firstName": "A String", # First name of this site contact.
+          "title": "A String", # Title or designation of this site contact.
+          "lastName": "A String", # Last name of this site contact.
+          "address": "A String", # Address of this site contact.
+          "email": "A String", # Email address of this site contact. This is a required field.
+          "phone": "A String", # Primary phone number of this site contact.
+          "contactType": "A String", # Site contact type.
+          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+        },
+      ],
+      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new site.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a site.
+    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteSettings": { # Site Settings # Site-wide settings.
+      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "creativeSettings": { # Creative Settings # Site-wide creative settings.
+        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+      },
+      "videoActiveViewOptOut": True or False, # 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.
+    },
+    "approved": True or False, # Whether this site is approved.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteContacts": [ # Site contacts.
+      { # Site Contact
+        "firstName": "A String", # First name of this site contact.
+        "title": "A String", # Title or designation of this site contact.
+        "lastName": "A String", # Last name of this site contact.
+        "address": "A String", # Address of this site contact.
+        "email": "A String", # Email address of this site contact. This is a required field.
+        "phone": "A String", # Primary phone number of this site contact.
+        "contactType": "A String", # Site contact type.
+        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+      },
+    ],
+    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a site.
+      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteSettings": { # Site Settings # Site-wide settings.
+        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+          "additionalKeyValues": "A String", # 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.
+          "keywordOption": "A String", # 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.
+        },
+        "creativeSettings": { # Creative Settings # Site-wide creative settings.
+          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        },
+        "videoActiveViewOptOut": True or False, # 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.
+      },
+      "approved": True or False, # Whether this site is approved.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteContacts": [ # Site contacts.
+        { # Site Contact
+          "firstName": "A String", # First name of this site contact.
+          "title": "A String", # Title or designation of this site contact.
+          "lastName": "A String", # Last name of this site contact.
+          "address": "A String", # Address of this site contact.
+          "email": "A String", # Email address of this site contact. This is a required field.
+          "phone": "A String", # Primary phone number of this site contact.
+          "contactType": "A String", # Site contact type.
+          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+        },
+      ],
+      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, unmappedSite=None, campaignIds=None, acceptsInStreamVideoPlacements=None, pageToken=None, acceptsPublisherPaidPlacements=None, sortOrder=None, acceptsInterstitialPlacements=None, maxResults=None, adWordsSite=None, approved=None, searchString=None, subaccountId=None, directorySiteIds=None, sortField=None, ids=None) +
Retrieves a list of sites, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
+  campaignIds: string, Select only sites with these campaign IDs. (repeated)
+  acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
+  maxResults: integer, Maximum number of results to return.
+  adWordsSite: boolean, Select only AdWords sites.
+  approved: boolean, Select only approved sites.
+  searchString: string, 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".
+  subaccountId: string, Select only sites with this subaccount ID.
+  directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only sites with these IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # Site List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#sitesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
+    "sites": [ # Site collection.
+      { # Contains properties of a site.
+          "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+          "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+          "name": "A String", # 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.
+          "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "siteSettings": { # Site Settings # Site-wide settings.
+            "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+            "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+            "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+              "clickDuration": 42, # 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.
+              "postImpressionActivitiesDuration": 42, # 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.
+            },
+            "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+            "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+              "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+              "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+              "additionalKeyValues": "A String", # 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.
+              "keywordOption": "A String", # 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.
+            },
+            "creativeSettings": { # Creative Settings # Site-wide creative settings.
+              "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+              "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+            },
+            "videoActiveViewOptOut": True or False, # 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.
+          },
+          "approved": True or False, # Whether this site is approved.
+          "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+            "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+            "value": "A String", # The value of the dimension.
+            "dimensionName": "A String", # The name of the dimension.
+            "etag": "A String", # The eTag of this response for caching purposes.
+            "matchType": "A String", # 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.
+            "id": "A String", # The ID associated with the value if available.
+          },
+          "siteContacts": [ # Site contacts.
+            { # Site Contact
+              "firstName": "A String", # First name of this site contact.
+              "title": "A String", # Title or designation of this site contact.
+              "lastName": "A String", # Last name of this site contact.
+              "address": "A String", # Address of this site contact.
+              "email": "A String", # Email address of this site contact. This is a required field.
+              "phone": "A String", # Primary phone number of this site contact.
+              "contactType": "A String", # Site contact type.
+              "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+            },
+          ],
+          "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+          "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+          "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing site. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Site ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a site.
+    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteSettings": { # Site Settings # Site-wide settings.
+      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "creativeSettings": { # Creative Settings # Site-wide creative settings.
+        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+      },
+      "videoActiveViewOptOut": True or False, # 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.
+    },
+    "approved": True or False, # Whether this site is approved.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteContacts": [ # Site contacts.
+      { # Site Contact
+        "firstName": "A String", # First name of this site contact.
+        "title": "A String", # Title or designation of this site contact.
+        "lastName": "A String", # Last name of this site contact.
+        "address": "A String", # Address of this site contact.
+        "email": "A String", # Email address of this site contact. This is a required field.
+        "phone": "A String", # Primary phone number of this site contact.
+        "contactType": "A String", # Site contact type.
+        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+      },
+    ],
+    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a site.
+      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteSettings": { # Site Settings # Site-wide settings.
+        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+          "additionalKeyValues": "A String", # 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.
+          "keywordOption": "A String", # 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.
+        },
+        "creativeSettings": { # Creative Settings # Site-wide creative settings.
+          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        },
+        "videoActiveViewOptOut": True or False, # 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.
+      },
+      "approved": True or False, # Whether this site is approved.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteContacts": [ # Site contacts.
+        { # Site Contact
+          "firstName": "A String", # First name of this site contact.
+          "title": "A String", # Title or designation of this site contact.
+          "lastName": "A String", # Last name of this site contact.
+          "address": "A String", # Address of this site contact.
+          "email": "A String", # Email address of this site contact. This is a required field.
+          "phone": "A String", # Primary phone number of this site contact.
+          "contactType": "A String", # Site contact type.
+          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+        },
+      ],
+      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing site.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a site.
+    "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+    "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+    "name": "A String", # 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.
+    "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteSettings": { # Site Settings # Site-wide settings.
+      "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+      "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+      "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+        "clickDuration": 42, # 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.
+        "postImpressionActivitiesDuration": 42, # 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.
+      },
+      "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+      "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+        "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+        "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+        "additionalKeyValues": "A String", # 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.
+        "keywordOption": "A String", # 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.
+      },
+      "creativeSettings": { # Creative Settings # Site-wide creative settings.
+        "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+      },
+      "videoActiveViewOptOut": True or False, # 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.
+    },
+    "approved": True or False, # Whether this site is approved.
+    "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "siteContacts": [ # Site contacts.
+      { # Site Contact
+        "firstName": "A String", # First name of this site contact.
+        "title": "A String", # Title or designation of this site contact.
+        "lastName": "A String", # Last name of this site contact.
+        "address": "A String", # Address of this site contact.
+        "email": "A String", # Email address of this site contact. This is a required field.
+        "phone": "A String", # Primary phone number of this site contact.
+        "contactType": "A String", # Site contact type.
+        "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+      },
+    ],
+    "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+    "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+    "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a site.
+      "kind": "dfareporting#site", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
+      "subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
+      "name": "A String", # 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.
+      "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteSettings": { # Site Settings # Site-wide settings.
+        "disableBrandSafeAds": True or False, # Whether brand safe ads are disabled for this site.
+        "activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
+        "lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for this site.
+          "clickDuration": 42, # 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.
+          "postImpressionActivitiesDuration": 42, # 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.
+        },
+        "disableNewCookie": True or False, # Whether new cookies are disabled for this site.
+        "tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
+          "includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
+          "includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
+          "additionalKeyValues": "A String", # 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.
+          "keywordOption": "A String", # 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.
+        },
+        "creativeSettings": { # Creative Settings # Site-wide creative settings.
+          "iFrameHeader": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+          "iFrameFooter": "A String", # Header text for iFrames for this site. Must be less than or equal to 2000 characters long.
+        },
+        "videoActiveViewOptOut": True or False, # 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.
+      },
+      "approved": True or False, # Whether this site is approved.
+      "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
+        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+        "value": "A String", # The value of the dimension.
+        "dimensionName": "A String", # The name of the dimension.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "matchType": "A String", # 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.
+        "id": "A String", # The ID associated with the value if available.
+      },
+      "siteContacts": [ # Site contacts.
+        { # Site Contact
+          "firstName": "A String", # First name of this site contact.
+          "title": "A String", # Title or designation of this site contact.
+          "lastName": "A String", # Last name of this site contact.
+          "address": "A String", # Address of this site contact.
+          "email": "A String", # Email address of this site contact. This is a required field.
+          "phone": "A String", # Primary phone number of this site contact.
+          "contactType": "A String", # Site contact type.
+          "id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
+        },
+      ],
+      "keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
+      "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
+      "id": "A String", # ID of this site. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.sizes.html b/docs/dyn/dfareporting_v2_4.sizes.html new file mode 100644 index 00000000000..9bc012a0320 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.sizes.html @@ -0,0 +1,165 @@ + + + +

DCM/DFA Reporting And Trafficking API . sizes

+

Instance Methods

+

+ get(profileId, id)

+

Gets one size by ID.

+

+ insert(profileId, body)

+

Inserts a new size.

+

+ list(profileId, iabStandard=None, width=None, ids=None, height=None)

+

Retrieves a list of sizes, possibly filtered.

+

Method Details

+
+ get(profileId, id) +
Gets one size by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Size ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents the dimensions of ads, placements, creatives, or creative assets.
+    "width": 42, # Width of this size.
+    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+    "height": 42, # Height of this size.
+  }
+
+ +
+ insert(profileId, body) +
Inserts a new size.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents the dimensions of ads, placements, creatives, or creative assets.
+  "width": 42, # Width of this size.
+  "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+  "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+  "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+  "height": 42, # Height of this size.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Represents the dimensions of ads, placements, creatives, or creative assets.
+    "width": 42, # Width of this size.
+    "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+    "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+    "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+    "height": 42, # Height of this size.
+  }
+
+ +
+ list(profileId, iabStandard=None, width=None, ids=None, height=None) +
Retrieves a list of sizes, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  iabStandard: boolean, Select only IAB standard sizes.
+  width: integer, Select only sizes with this width.
+  ids: string, Select only sizes with these IDs. (repeated)
+  height: integer, Select only sizes with this height.
+
+Returns:
+  An object of the form:
+
+    { # Size List Response
+    "kind": "dfareporting#sizesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sizesListResponse".
+    "sizes": [ # Size collection.
+      { # Represents the dimensions of ads, placements, creatives, or creative assets.
+        "width": 42, # Width of this size.
+        "kind": "dfareporting#size", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
+        "iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
+        "id": "A String", # ID of this size. This is a read-only, auto-generated field.
+        "height": 42, # Height of this size.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.subaccounts.html b/docs/dyn/dfareporting_v2_4.subaccounts.html new file mode 100644 index 00000000000..69bb7768533 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.subaccounts.html @@ -0,0 +1,274 @@ + + + +

DCM/DFA Reporting And Trafficking API . subaccounts

+

Instance Methods

+

+ get(profileId, id)

+

Gets one subaccount by ID.

+

+ insert(profileId, body)

+

Inserts a new subaccount.

+

+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None)

+

Gets a list of subaccounts, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing subaccount. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing subaccount.

+

Method Details

+
+ get(profileId, id) +
Gets one subaccount by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Subaccount ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM subaccount.
+      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+        "A String",
+      ],
+      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new subaccount.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM subaccount.
+    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+      "A String",
+    ],
+    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM subaccount.
+      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+        "A String",
+      ],
+      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, pageToken=None, sortField=None, ids=None, maxResults=None, sortOrder=None) +
Gets a list of subaccounts, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  ids: string, Select only subaccounts with these IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Subaccount List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#subaccountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse".
+    "subaccounts": [ # Subaccount collection.
+      { # Contains properties of a DCM subaccount.
+          "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+          "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+            "A String",
+          ],
+          "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+          "name": "A String", # 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.
+          "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing subaccount. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Subaccount ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM subaccount.
+    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+      "A String",
+    ],
+    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM subaccount.
+      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+        "A String",
+      ],
+      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing subaccount.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of a DCM subaccount.
+    "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+    "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+      "A String",
+    ],
+    "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+    "name": "A String", # 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.
+    "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a DCM subaccount.
+      "kind": "dfareporting#subaccount", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount".
+      "availablePermissionIds": [ # IDs of the available user role permissions for this subaccount.
+        "A String",
+      ],
+      "id": "A String", # ID of this subaccount. This is a read-only, auto-generated field.
+      "name": "A String", # 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.
+      "accountId": "A String", # ID of the account that contains this subaccount. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.targetableRemarketingLists.html b/docs/dyn/dfareporting_v2_4.targetableRemarketingLists.html new file mode 100644 index 00000000000..fa5b2a6368d --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.targetableRemarketingLists.html @@ -0,0 +1,187 @@ + + + +

DCM/DFA Reporting And Trafficking API . targetableRemarketingLists

+

Instance Methods

+

+ get(profileId, id)

+

Gets one remarketing list by ID.

+

+ list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None)

+

Retrieves a list of targetable remarketing lists, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(profileId, id) +
Gets one remarketing list by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, Remarketing list ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # 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.
+    "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
+    "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+    "description": "A String", # Targetable remarketing list description.
+    "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+    "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
+    "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
+    "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
+    "listSource": "A String", # Product from which this targetable remarketing list was originated.
+    "active": True or False, # Whether this targetable remarketing list is active.
+    "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
+      "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+      "value": "A String", # The value of the dimension.
+      "dimensionName": "A String", # The name of the dimension.
+      "etag": "A String", # The eTag of this response for caching purposes.
+      "matchType": "A String", # 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.
+      "id": "A String", # The ID associated with the value if available.
+    },
+    "id": "A String", # Targetable remarketing list ID.
+    "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+  }
+
+ +
+ list(profileId, advertiserId, name=None, pageToken=None, sortField=None, maxResults=None, active=None, sortOrder=None) +
Retrieves a list of targetable remarketing lists, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  advertiserId: string, Select only targetable remarketing lists targetable by these advertisers. (required)
+  name: string, 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".
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+  maxResults: integer, Maximum number of results to return.
+  active: boolean, Select only active or only inactive targetable remarketing lists.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+
+Returns:
+  An object of the form:
+
+    { # Targetable remarketing list response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#targetableRemarketingListsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse".
+    "targetableRemarketingLists": [ # Targetable remarketing list collection.
+      { # 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.
+        "kind": "dfareporting#targetableRemarketingList", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList".
+        "subaccountId": "A String", # Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+        "description": "A String", # Targetable remarketing list description.
+        "listSize": "A String", # Number of users currently in the list. This is a read-only field.
+        "lifeSpan": "A String", # Number of days that a user should remain in the targetable remarketing list without an impression.
+        "name": "A String", # Name of the targetable remarketing list. Is no greater than 128 characters long.
+        "advertiserId": "A String", # Dimension value for the advertiser ID that owns this targetable remarketing list.
+        "listSource": "A String", # Product from which this targetable remarketing list was originated.
+        "active": True or False, # Whether this targetable remarketing list is active.
+        "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser.
+          "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+          "value": "A String", # The value of the dimension.
+          "dimensionName": "A String", # The name of the dimension.
+          "etag": "A String", # The eTag of this response for caching purposes.
+          "matchType": "A String", # 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.
+          "id": "A String", # The ID associated with the value if available.
+        },
+        "id": "A String", # Targetable remarketing list ID.
+        "accountId": "A String", # Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.userProfiles.html b/docs/dyn/dfareporting_v2_4.userProfiles.html new file mode 100644 index 00000000000..bb3e1a4b926 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.userProfiles.html @@ -0,0 +1,133 @@ + + + +

DCM/DFA Reporting And Trafficking API . userProfiles

+

Instance Methods

+

+ get(profileId)

+

Gets one user profile by ID.

+

+ list()

+

Retrieves list of user profiles for a user.

+

Method Details

+
+ get(profileId) +
Gets one user profile by ID.
+
+Args:
+  profileId: string, The user profile ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a UserProfile resource.
+    "userName": "A String", # The user name.
+    "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
+    "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
+    "accountName": "A String", # The account name this profile belongs to.
+    "etag": "A String", # The eTag of this response for caching purposes.
+    "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
+    "profileId": "A String", # The unique ID of the user profile.
+    "accountId": "A String", # The account ID to which this profile belongs.
+  }
+
+ +
+ list() +
Retrieves list of user profiles for a user.
+
+Args:
+
+Returns:
+  An object of the form:
+
+    { # Represents the list of user profiles.
+    "items": [ # The user profiles returned in this response.
+      { # Represents a UserProfile resource.
+        "userName": "A String", # The user name.
+        "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
+        "subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
+        "accountName": "A String", # The account name this profile belongs to.
+        "etag": "A String", # The eTag of this response for caching purposes.
+        "subAccountName": "A String", # The sub account name this profile belongs to if applicable.
+        "profileId": "A String", # The unique ID of the user profile.
+        "accountId": "A String", # The account ID to which this profile belongs.
+      },
+    ],
+    "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
+    "etag": "A String", # The eTag of this response for caching purposes.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.userRolePermissionGroups.html b/docs/dyn/dfareporting_v2_4.userRolePermissionGroups.html new file mode 100644 index 00000000000..c4cd0a35f98 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.userRolePermissionGroups.html @@ -0,0 +1,124 @@ + + + +

DCM/DFA Reporting And Trafficking API . userRolePermissionGroups

+

Instance Methods

+

+ get(profileId, id)

+

Gets one user role permission group by ID.

+

+ list(profileId)

+

Gets a list of all supported user role permission groups.

+

Method Details

+
+ get(profileId, id) +
Gets one user role permission group by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User role permission group ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a grouping of related user role permissions.
+    "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
+    "id": "A String", # ID of this user role permission.
+    "name": "A String", # Name of this user role permission group.
+  }
+
+ +
+ list(profileId) +
Gets a list of all supported user role permission groups.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # User Role Permission Group List Response
+    "userRolePermissionGroups": [ # User role permission group collection.
+      { # Represents a grouping of related user role permissions.
+        "kind": "dfareporting#userRolePermissionGroup", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroup".
+        "id": "A String", # ID of this user role permission.
+        "name": "A String", # Name of this user role permission group.
+      },
+    ],
+    "kind": "dfareporting#userRolePermissionGroupsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionGroupsListResponse".
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.userRolePermissions.html b/docs/dyn/dfareporting_v2_4.userRolePermissions.html new file mode 100644 index 00000000000..362066a46a8 --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.userRolePermissions.html @@ -0,0 +1,129 @@ + + + +

DCM/DFA Reporting And Trafficking API . userRolePermissions

+

Instance Methods

+

+ get(profileId, id)

+

Gets one user role permission by ID.

+

+ list(profileId, ids=None)

+

Gets a list of user role permissions, possibly filtered.

+

Method Details

+
+ get(profileId, id) +
Gets one user role permission by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User role permission ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of a user role permission.
+    "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+    "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+    "availability": "A String", # Levels of availability for a user role permission.
+    "name": "A String", # Name of this user role permission.
+    "id": "A String", # ID of this user role permission.
+  }
+
+ +
+ list(profileId, ids=None) +
Gets a list of user role permissions, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  ids: string, Select only user role permissions with these IDs. (repeated)
+
+Returns:
+  An object of the form:
+
+    { # User Role Permission List Response
+    "userRolePermissions": [ # User role permission collection.
+      { # Contains properties of a user role permission.
+        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+        "availability": "A String", # Levels of availability for a user role permission.
+        "name": "A String", # Name of this user role permission.
+        "id": "A String", # ID of this user role permission.
+      },
+    ],
+    "kind": "dfareporting#userRolePermissionsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermissionsListResponse".
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/dfareporting_v2_4.userRoles.html b/docs/dyn/dfareporting_v2_4.userRoles.html new file mode 100644 index 00000000000..8b16799863f --- /dev/null +++ b/docs/dyn/dfareporting_v2_4.userRoles.html @@ -0,0 +1,361 @@ + + + +

DCM/DFA Reporting And Trafficking API . userRoles

+

Instance Methods

+

+ delete(profileId, id)

+

Deletes an existing user role.

+

+ get(profileId, id)

+

Gets one user role by ID.

+

+ insert(profileId, body)

+

Inserts a new user role.

+

+ list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None)

+

Retrieves a list of user roles, possibly filtered.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(profileId, id, body)

+

Updates an existing user role. This method supports patch semantics.

+

+ update(profileId, body)

+

Updates an existing user role.

+

Method Details

+
+ delete(profileId, id) +
Deletes an existing user role.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User role ID. (required)
+
+
+ +
+ get(profileId, id) +
Gets one user role by ID.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User role ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of auser role, which is used to manage user access.
+      "defaultUserRole": True or False, # 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.
+      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+      "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+      "permissions": [ # List of permissions associated with this user role.
+        { # Contains properties of a user role permission.
+          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+          "availability": "A String", # Levels of availability for a user role permission.
+          "name": "A String", # Name of this user role permission.
+          "id": "A String", # ID of this user role permission.
+        },
+      ],
+      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+    }
+
+ +
+ insert(profileId, body) +
Inserts a new user role.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+    "defaultUserRole": True or False, # 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.
+    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+    "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+    "permissions": [ # List of permissions associated with this user role.
+      { # Contains properties of a user role permission.
+        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+        "availability": "A String", # Levels of availability for a user role permission.
+        "name": "A String", # Name of this user role permission.
+        "id": "A String", # ID of this user role permission.
+      },
+    ],
+    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of auser role, which is used to manage user access.
+      "defaultUserRole": True or False, # 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.
+      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+      "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+      "permissions": [ # List of permissions associated with this user role.
+        { # Contains properties of a user role permission.
+          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+          "availability": "A String", # Levels of availability for a user role permission.
+          "name": "A String", # Name of this user role permission.
+          "id": "A String", # ID of this user role permission.
+        },
+      ],
+      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+    }
+
+ +
+ list(profileId, searchString=None, subaccountId=None, pageToken=None, ids=None, maxResults=None, accountUserRoleOnly=None, sortOrder=None, sortField=None) +
Retrieves a list of user roles, possibly filtered.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  searchString: string, 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".
+  subaccountId: string, Select only user roles that belong to this subaccount.
+  pageToken: string, Value of the nextPageToken from the previous result page.
+  ids: string, Select only user roles with the specified IDs. (repeated)
+  maxResults: integer, Maximum number of results to return.
+  accountUserRoleOnly: boolean, Select only account level user roles not associated with any specific subaccount.
+  sortOrder: string, Order of sorted results, default is ASCENDING.
+    Allowed values
+      ASCENDING - 
+      DESCENDING - 
+  sortField: string, Field by which to sort the list.
+    Allowed values
+      ID - 
+      NAME - 
+
+Returns:
+  An object of the form:
+
+    { # User Role List Response
+    "nextPageToken": "A String", # Pagination token to be used for the next list operation.
+    "kind": "dfareporting#userRolesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolesListResponse".
+    "userRoles": [ # User role collection.
+      { # Contains properties of auser role, which is used to manage user access.
+          "defaultUserRole": True or False, # 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.
+          "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+          "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+          "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+          "permissions": [ # List of permissions associated with this user role.
+            { # Contains properties of a user role permission.
+              "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+              "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+              "availability": "A String", # Levels of availability for a user role permission.
+              "name": "A String", # Name of this user role permission.
+              "id": "A String", # ID of this user role permission.
+            },
+          ],
+          "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+          "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(profileId, id, body) +
Updates an existing user role. This method supports patch semantics.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  id: string, User role ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+    "defaultUserRole": True or False, # 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.
+    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+    "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+    "permissions": [ # List of permissions associated with this user role.
+      { # Contains properties of a user role permission.
+        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+        "availability": "A String", # Levels of availability for a user role permission.
+        "name": "A String", # Name of this user role permission.
+        "id": "A String", # ID of this user role permission.
+      },
+    ],
+    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of auser role, which is used to manage user access.
+      "defaultUserRole": True or False, # 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.
+      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+      "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+      "permissions": [ # List of permissions associated with this user role.
+        { # Contains properties of a user role permission.
+          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+          "availability": "A String", # Levels of availability for a user role permission.
+          "name": "A String", # Name of this user role permission.
+          "id": "A String", # ID of this user role permission.
+        },
+      ],
+      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+    }
+
+ +
+ update(profileId, body) +
Updates an existing user role.
+
+Args:
+  profileId: string, User profile ID associated with this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Contains properties of auser role, which is used to manage user access.
+    "defaultUserRole": True or False, # 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.
+    "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+    "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+    "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+    "permissions": [ # List of permissions associated with this user role.
+      { # Contains properties of a user role permission.
+        "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+        "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+        "availability": "A String", # Levels of availability for a user role permission.
+        "name": "A String", # Name of this user role permission.
+        "id": "A String", # ID of this user role permission.
+      },
+    ],
+    "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+    "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Contains properties of auser role, which is used to manage user access.
+      "defaultUserRole": True or False, # 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.
+      "kind": "dfareporting#userRole", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRole".
+      "subaccountId": "A String", # Subaccount ID of this user role. This is a read-only field that can be left blank.
+      "name": "A String", # 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": "A String", # ID of the user role that this user role is based on or copied from. This is a required field.
+      "permissions": [ # List of permissions associated with this user role.
+        { # Contains properties of a user role permission.
+          "permissionGroupId": "A String", # ID of the permission group that this user role permission belongs to.
+          "kind": "dfareporting#userRolePermission", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#userRolePermission".
+          "availability": "A String", # Levels of availability for a user role permission.
+          "name": "A String", # Name of this user role permission.
+          "id": "A String", # ID of this user role permission.
+        },
+      ],
+      "id": "A String", # ID of this user role. This is a read-only, auto-generated field.
+      "accountId": "A String", # Account ID of this user role. This is a read-only field that can be left blank.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/discovery_v1.apis.html b/docs/dyn/discovery_v1.apis.html index 22c10dd04f2..c388d81a355 100644 --- a/docs/dyn/discovery_v1.apis.html +++ b/docs/dyn/discovery_v1.apis.html @@ -391,6 +391,7 @@

Method Details

"title": "A String", # The title of this API. "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. + "version_module": True or False, "documentationLink": "A String", # A link to human readable documentation for the API. } diff --git a/docs/dyn/dns_v1.changes.html b/docs/dyn/dns_v1.changes.html index 96452117c8f..d8a2061fd0b 100644 --- a/docs/dyn/dns_v1.changes.html +++ b/docs/dyn/dns_v1.changes.html @@ -111,7 +111,7 @@

Method Details

], "status": "A String", # Status of the operation (output only). "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change". - "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format. + "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that will be returned by the DNS servers. "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). @@ -144,7 +144,7 @@

Method Details

], "status": "A String", # Status of the operation (output only). "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change". - "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format. + "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that will be returned by the DNS servers. "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). @@ -186,7 +186,7 @@

Method Details

], "status": "A String", # Status of the operation (output only). "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change". - "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format. + "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that will be returned by the DNS servers. "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). @@ -239,7 +239,7 @@

Method Details

], "status": "A String", # Status of the operation (output only). "kind": "dns#change", # Identifies what kind of resource this is. Value: the fixed string "dns#change". - "startTime": "A String", # The time that this operation was started by the server. This is in RFC3339 text format. + "startTime": "A String", # The time that this operation was started by the server (output only). This is in RFC3339 text format. "additions": [ # Which ResourceRecordSets to add? { # A unit of data that will be returned by the DNS servers. "rrdatas": [ # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). diff --git a/docs/dyn/doubleclickbidmanager_v1.html b/docs/dyn/doubleclickbidmanager_v1.html index 1774cd0d322..2ab1781d931 100644 --- a/docs/dyn/doubleclickbidmanager_v1.html +++ b/docs/dyn/doubleclickbidmanager_v1.html @@ -89,6 +89,11 @@

Instance Methods

Returns the reports Resource.

+

+ rubicon() +

+

Returns the rubicon Resource.

+

new_batch_http_request()

Create a BatchHttpRequest object based on the discovery document.

diff --git a/docs/dyn/doubleclickbidmanager_v1.lineitems.html b/docs/dyn/doubleclickbidmanager_v1.lineitems.html index 821d7d6b1e5..a17656a500e 100644 --- a/docs/dyn/doubleclickbidmanager_v1.lineitems.html +++ b/docs/dyn/doubleclickbidmanager_v1.lineitems.html @@ -90,6 +90,7 @@

Method Details

The object takes the form of: { # Request to fetch stored line items. + "fileSpec": "A String", # File specification (column names, types, order) in which the line items will be returned. Default to EWF. "filterType": "A String", # Filter type used to filter line items to fetch. "filterIds": [ # Ids of the specified filter type used to filter line items to fetch. If omitted, all the line items will be returned. "A String", @@ -102,7 +103,7 @@

Method Details

An object of the form: { # Download line items response. - "lineItems": "A String", # Retrieved line items in CSV format. Refer to Entity Write File Format for more information on file format. + "lineItems": "A String", # Retrieved line items in CSV format. Refer to Entity Write File Format or Structured Data File Format for more information on file formats. } diff --git a/docs/dyn/doubleclickbidmanager_v1.rubicon.html b/docs/dyn/doubleclickbidmanager_v1.rubicon.html new file mode 100644 index 00000000000..3948d912988 --- /dev/null +++ b/docs/dyn/doubleclickbidmanager_v1.rubicon.html @@ -0,0 +1,108 @@ + + + +

DoubleClick Bid Manager API . rubicon

+

Instance Methods

+

+ notifyproposalchange(body)

+

Update proposal upon actions of Rubicon publisher.

+

Method Details

+
+ notifyproposalchange(body) +
Update proposal upon actions of Rubicon publisher.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # NotifyProposalChange request.
+    "action": "A String", # Action taken by publisher. One of: Accept, Decline, Append
+    "notes": [ # Notes from publisher
+      { # Publisher comment from Rubicon.
+        "username": "A String", # Publisher user name.
+        "source": "A String", # Equals "publisher" for notification from Rubicon.
+        "message": "A String", # Message from publisher.
+        "id": "A String", # Note id.
+        "timestamp": "A String", # Time when the note was added, e.g. "2015-12-16T17:25:35.000-08:00".
+      },
+    ],
+    "href": "A String", # URL to access proposal detail.
+    "id": "A String", # Below are contents of notification from Rubicon. Proposal id.
+    "token": "A String", # Deal token, available when proposal is accepted by publisher.
+  }
+
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/doubleclicksearch_v2.conversion.html b/docs/dyn/doubleclicksearch_v2.conversion.html index 79eb06b1adc..19b91a940c4 100644 --- a/docs/dyn/doubleclicksearch_v2.conversion.html +++ b/docs/dyn/doubleclicksearch_v2.conversion.html @@ -123,7 +123,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -134,7 +134,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -185,7 +185,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -196,7 +196,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -242,7 +242,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -253,7 +253,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -311,7 +311,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -322,7 +322,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -368,7 +368,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -379,7 +379,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -430,7 +430,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -441,7 +441,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store @@ -487,7 +487,7 @@

Method Details

"segmentationName": "A String", # The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). "attributionModel": "A String", # This field is ignored. "campaignId": "A String", # DS campaign ID. - "revenueMicros": "A String", # The revenue amount of this TRANSACTION conversion, in micros. + "revenueMicros": "A String", # 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. "advertiserId": "A String", # DS advertiser ID. "countMillis": "A String", # This field is ignored. "conversionTimestamp": "A String", # The time at which the conversion took place, in epoch millis UTC. @@ -498,7 +498,7 @@

Method Details

"state": "A String", # The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. "deviceType": "A String", # The type of device on which the conversion occurred. "adId": "A String", # DS ad ID. - "conversionId": "A String", # For offline conversions, this is an ID provided by advertisers. Advertisers can use this property to specify an ID that is meaningful to them. If an advertiser doesn't specify a conversionId, DoubleClick Search generates one. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. + "conversionId": "A String", # For offline conversions, this is an ID that advertisers are required to provide. Advertisers can specify any ID that is meaningful to them. For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions. "conversionModifiedTimestamp": "A String", # The time at which the conversion was last modified, in epoch millis UTC. "channel": "A String", # Sales channel for the product. Acceptable values are: # - "local": a physical store diff --git a/docs/dyn/doubleclicksearch_v2.reports.html b/docs/dyn/doubleclicksearch_v2.reports.html index fcb7a39fa5e..715e3fb8471 100644 --- a/docs/dyn/doubleclicksearch_v2.reports.html +++ b/docs/dyn/doubleclicksearch_v2.reports.html @@ -103,6 +103,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -110,7 +113,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "sortOrder": "A String", # The sort direction, which is either ascending or descending. @@ -141,6 +144,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -148,7 +154,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators. @@ -162,6 +168,9 @@

Method Details

"columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. { # A request object used to create a DoubleClick Search report. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -169,7 +178,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, ], @@ -198,6 +207,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -205,7 +217,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "sortOrder": "A String", # The sort direction, which is either ascending or descending. @@ -236,6 +248,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -243,7 +258,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators. @@ -257,6 +272,9 @@

Method Details

"columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. { # A request object used to create a DoubleClick Search report. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -264,7 +282,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, ], @@ -306,6 +324,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -313,7 +334,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "sortOrder": "A String", # The sort direction, which is either ascending or descending. @@ -344,6 +365,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -351,7 +375,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators. @@ -365,6 +389,9 @@

Method Details

"columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. { # A request object used to create a DoubleClick Search report. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -372,7 +399,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, ], @@ -419,6 +446,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -426,7 +456,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "sortOrder": "A String", # The sort direction, which is either ascending or descending. @@ -457,6 +487,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -464,7 +497,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators. @@ -478,6 +511,9 @@

Method Details

"columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. { # A request object used to create a DoubleClick Search report. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -485,7 +521,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, ], @@ -514,6 +550,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -521,7 +560,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "sortOrder": "A String", # The sort direction, which is either ascending or descending. @@ -552,6 +591,9 @@

Method Details

{ "column": { # A request object used to create a DoubleClick Search report. # Column to perform the filter on. This can be a DoubleClick Search column or a saved column. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -559,7 +601,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, "operator": "A String", # Operator to use in the filter. See the filter reference for a list of available operators. @@ -573,6 +615,9 @@

Method Details

"columns": [ # The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza. { # A request object used to create a DoubleClick Search report. "groupByColumn": false, # Synchronous report only. Set to true to group by this column. Defaults to false. + "productReportPerspective": "A String", # Returns metrics only for a specific type of product activity. Accepted values are: + # - "sold": returns metrics only for products that were sold + # - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold "endDate": "A String", # Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with startDate. "savedColumnName": "A String", # Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI. "customDimensionName": "A String", # Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive. @@ -580,7 +625,7 @@

Method Details

"startDate": "A String", # Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with endDate. "headerText": "A String", # Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name. "columnName": "A String", # Name of a DoubleClick Search column to include in the report. - "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "Floodlight". + "platformSource": "A String", # The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". "customMetricName": "A String", # Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive. }, ], diff --git a/docs/dyn/drive_v3.about.html b/docs/dyn/drive_v3.about.html new file mode 100644 index 00000000000..18c382ea54b --- /dev/null +++ b/docs/dyn/drive_v3.about.html @@ -0,0 +1,127 @@ + + + +

Drive API . about

+

Instance Methods

+

+ get()

+

Gets information about the user, the user's Drive, and system capabilities.

+

Method Details

+
+ get() +
Gets information about the user, the user's Drive, and system capabilities.
+
+Args:
+
+Returns:
+  An object of the form:
+
+    { # Information about the user, the user's Drive, and system capabilities.
+    "kind": "drive#about", # This is always drive#about.
+    "maxUploadSize": "A String", # The maximum upload size in bytes.
+    "maxImportSizes": { # A map of maximum import sizes by MIME type, in bytes.
+      "a_key": "A String",
+    },
+    "storageQuota": { # The user's storage quota limits and usage. All fields are measured in bytes.
+      "usage": "A String", # The total usage across all services.
+      "usageInDrive": "A String", # The usage by all files in Google Drive.
+      "usageInDriveTrash": "A String", # The usage by trashed files in Google Drive.
+      "limit": "A String", # The usage limit, if applicable. This will not be present if the user has unlimited storage.
+    },
+    "importFormats": { # A map of source MIME type to possible targets for all supported imports.
+      "a_key": [
+        "A String",
+      ],
+    },
+    "appInstalled": True or False, # Whether the user has installed the requesting app.
+    "folderColorPalette": [ # The currently supported folder colors as RGB hex strings.
+      "A String",
+    ],
+    "exportFormats": { # A map of source MIME type to possible targets for all supported exports.
+      "a_key": [
+        "A String",
+      ],
+    },
+    "user": { # Information about a Drive user. # The authenticated user.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html new file mode 100644 index 00000000000..1c2bf293aa2 --- /dev/null +++ b/docs/dyn/drive_v3.changes.html @@ -0,0 +1,342 @@ + + + +

Drive API . changes

+

Instance Methods

+

+ getStartPageToken()

+

Gets the starting pageToken for listing future changes.

+

+ list(pageToken, restrictToMyDrive=None, spaces=None, pageSize=None, includeRemoved=None)

+

Lists changes for a user.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ watch(pageToken, body, pageSize=None, restrictToMyDrive=None, spaces=None, includeRemoved=None)

+

Subscribes to changes for a user.

+

Method Details

+
+ getStartPageToken() +
Gets the starting pageToken for listing future changes.
+
+Args:
+
+Returns:
+  An object of the form:
+
+    {
+    "kind": "drive#startPageToken", # This is always drive#startPageToken.
+    "startPageToken": "A String", # The starting page token for listing changes.
+  }
+
+ +
+ list(pageToken, restrictToMyDrive=None, spaces=None, pageSize=None, includeRemoved=None) +
Lists changes for a user.
+
+Args:
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
+  restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
+  spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
+  pageSize: integer, The maximum number of changes to return per page.
+  includeRemoved: boolean, Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.
+
+Returns:
+  An object of the form:
+
+    { # A list of changes for a user.
+    "nextPageToken": "A String", # The page token for the next page of changes. This will be absent if the end of the current changes list has been reached.
+    "kind": "drive#changeList", # This is always drive#changeList.
+    "changes": [ # The page of changes.
+      { # A change to a file.
+        "kind": "drive#change", # This is always drive#change.
+        "removed": True or False, # Whether the file has been removed from the view of the changes list, for example by deletion or lost access.
+        "time": "A String", # The time of this change (RFC 3339 date-time).
+        "file": { # The metadata for a file. # The updated state of the file. Present if the file has not been removed.
+          "mimeType": "A String", # The MIME type of the file.
+              # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+              # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+          "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+          "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+          "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+          "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+          "ownedByMe": True or False, # Whether the user owns the file.
+          "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+          "id": "A String", # The ID of the file.
+          "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+          "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+            "width": 42, # The width of the video in pixels.
+            "durationMillis": "A String", # The duration of the video in milliseconds.
+            "height": 42, # The height of the video in pixels.
+          },
+          "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+              # If an unsupported color is specified, the closest color in the palette will be used instead.
+          "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+              # Entries with null values are cleared in update and copy requests.
+            "a_key": "A String",
+          },
+          "capabilities": { # Capabilities the current user has on the file.
+            "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+            "canCopy": True or False, # Whether the user can copy the file.
+            "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+            "canEdit": True or False, # Whether the user can edit the file's content.
+            "canComment": True or False, # Whether the user can comment on the file.
+          },
+          "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+          "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+          "parents": [ # The IDs of the parent folders which contain the file.
+              # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+            "A String",
+          ],
+          "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+          "shared": True or False, # Whether the file has been shared.
+          "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+            { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+              "domain": "A String", # The domain to which this permission refers.
+              "displayName": "A String", # A displayable name for users, groups or domains.
+              "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+              "kind": "drive#permission", # This is always drive#permission.
+              "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+              "photoLink": "A String", # A link to the user's profile photo, if available.
+              "role": "A String", # The role granted by this permission. Valid values are:
+                  # - owner
+                  # - writer
+                  # - commenter
+                  # - reader
+              "type": "A String", # The type of the grantee. Valid values are:
+                  # - user
+                  # - group
+                  # - domain
+                  # - anyone
+              "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+            },
+          ],
+          "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+              # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+          "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+          "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+          "description": "A String", # A short description of the file.
+          "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+              # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+          "viewedByMe": True or False, # Whether the file has been viewed by this user.
+          "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+            { # Information about a Drive user.
+              "me": True or False, # Whether this user is the requesting user.
+              "kind": "drive#user", # This is always drive#user.
+              "displayName": "A String", # A plain text displayable name for this user.
+              "permissionId": "A String", # The user's ID as visible in Permission resources.
+              "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+              "photoLink": "A String", # A link to the user's profile photo, if available.
+            },
+          ],
+          "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+          "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+          "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+              # Entries with null values are cleared in update and copy requests.
+            "a_key": "A String",
+          },
+          "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+          "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+          "imageMediaMetadata": { # Additional metadata about image media, if available.
+            "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+            "exposureTime": 3.14, # The length of the exposure, in seconds.
+            "cameraMake": "A String", # The make of the camera used to create the photo.
+            "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+            "width": 42, # The width of the image in pixels.
+            "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+            "exposureMode": "A String", # The exposure mode used to create the photo.
+            "colorSpace": "A String", # The color space of the photo.
+            "location": { # Geographic location information stored in the image.
+              "latitude": 3.14, # The latitude stored in the image.
+              "altitude": 3.14, # The altitude stored in the image.
+              "longitude": 3.14, # The longitude stored in the image.
+            },
+            "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+            "height": 42, # The height of the image in pixels.
+            "lens": "A String", # The lens used to create the photo.
+            "isoSpeed": 42, # The ISO speed used to create the photo.
+            "meteringMode": "A String", # The metering mode used to create the photo.
+            "flashUsed": True or False, # Whether a flash was used to create the photo.
+            "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+            "aperture": 3.14, # The aperture used to create the photo (f-number).
+            "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+            "sensor": "A String", # The type of sensor used to create the photo.
+            "whiteBalance": "A String", # The white balance mode used to create the photo.
+            "cameraModel": "A String", # The model of the camera used to create the photo.
+          },
+          "kind": "drive#file", # This is always drive#file.
+          "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+          "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+          "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+            "A String",
+          ],
+          "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+          "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+            "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+            "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+              "mimeType": "A String", # The MIME type of the thumbnail.
+              "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+            },
+          },
+          "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+          "starred": True or False, # Whether the user has starred the file.
+          "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+        },
+        "fileId": "A String", # The ID of the file which has changed.
+      },
+    ],
+    "newStartPageToken": "A String", # The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ watch(pageToken, body, pageSize=None, restrictToMyDrive=None, spaces=None, includeRemoved=None) +
Subscribes to changes for a user.
+
+Args:
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+    "resourceUri": "A String", # A version-specific identifier for the watched resource.
+    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+    "params": { # Additional parameters controlling delivery channel behavior. Optional.
+      "a_key": "A String", # Declares a new parameter by name.
+    },
+    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+    "address": "A String", # The address where notifications are delivered for this channel.
+    "type": "A String", # The type of delivery mechanism used for this channel.
+    "id": "A String", # A UUID or similar unique string that identifies this channel.
+  }
+
+  pageSize: integer, The maximum number of changes to return per page.
+  restrictToMyDrive: boolean, Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.
+  spaces: string, A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
+  includeRemoved: boolean, Whether to include changes indicating that items have left the view of the changes list, for example by deletion or lost access.
+
+Returns:
+  An object of the form:
+
+    { # An notification channel used to watch for resource changes.
+      "resourceUri": "A String", # A version-specific identifier for the watched resource.
+      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+      "params": { # Additional parameters controlling delivery channel behavior. Optional.
+        "a_key": "A String", # Declares a new parameter by name.
+      },
+      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+      "address": "A String", # The address where notifications are delivered for this channel.
+      "type": "A String", # The type of delivery mechanism used for this channel.
+      "id": "A String", # A UUID or similar unique string that identifies this channel.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.channels.html b/docs/dyn/drive_v3.channels.html new file mode 100644 index 00000000000..af5542d0fde --- /dev/null +++ b/docs/dyn/drive_v3.channels.html @@ -0,0 +1,107 @@ + + + +

Drive API . channels

+

Instance Methods

+

+ stop(body)

+

Stop watching resources through this channel

+

Method Details

+
+ stop(body) +
Stop watching resources through this channel
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+    "resourceUri": "A String", # A version-specific identifier for the watched resource.
+    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+    "params": { # Additional parameters controlling delivery channel behavior. Optional.
+      "a_key": "A String", # Declares a new parameter by name.
+    },
+    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+    "address": "A String", # The address where notifications are delivered for this channel.
+    "type": "A String", # The type of delivery mechanism used for this channel.
+    "id": "A String", # A UUID or similar unique string that identifies this channel.
+  }
+
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.comments.html b/docs/dyn/drive_v3.comments.html new file mode 100644 index 00000000000..628410e7a5d --- /dev/null +++ b/docs/dyn/drive_v3.comments.html @@ -0,0 +1,459 @@ + + + +

Drive API . comments

+

Instance Methods

+

+ create(fileId, body)

+

Creates a new comment on a file.

+

+ delete(fileId, commentId)

+

Deletes a comment.

+

+ get(fileId, commentId, includeDeleted=None)

+

Gets a comment by ID.

+

+ list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None)

+

Lists a file's comments.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ update(fileId, commentId, body)

+

Updates a comment with patch semantics.

+

Method Details

+
+ create(fileId, body) +
Creates a new comment on a file.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A comment on a file.
+    "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+    "kind": "drive#comment", # This is always drive#comment.
+    "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+    "author": { # Information about a Drive user. # The user who created the comment.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+    "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+      "mimeType": "A String", # The MIME type of the quoted content.
+      "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+    },
+    "htmlContent": "A String", # The content of the comment with HTML formatting.
+    "id": "A String", # The ID of the comment.
+    "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+    "replies": [ # The full list of replies to the comment in chronological order.
+      { # A reply to a comment on a file.
+        "kind": "drive#reply", # This is always drive#reply.
+        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+        "author": { # Information about a Drive user. # The user who created the reply.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+        "htmlContent": "A String", # The content of the reply with HTML formatting.
+        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+            # - resolve
+            # - reopen
+        "id": "A String", # The ID of the reply.
+      },
+    ],
+    "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+    "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # A comment on a file.
+      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+      "kind": "drive#comment", # This is always drive#comment.
+      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+      "author": { # Information about a Drive user. # The user who created the comment.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+        "mimeType": "A String", # The MIME type of the quoted content.
+        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+      },
+      "htmlContent": "A String", # The content of the comment with HTML formatting.
+      "id": "A String", # The ID of the comment.
+      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+      "replies": [ # The full list of replies to the comment in chronological order.
+        { # A reply to a comment on a file.
+          "kind": "drive#reply", # This is always drive#reply.
+          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+          "author": { # Information about a Drive user. # The user who created the reply.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+          "htmlContent": "A String", # The content of the reply with HTML formatting.
+          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+              # - resolve
+              # - reopen
+          "id": "A String", # The ID of the reply.
+        },
+      ],
+      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+      "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+    }
+
+ +
+ delete(fileId, commentId) +
Deletes a comment.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+
+
+ +
+ get(fileId, commentId, includeDeleted=None) +
Gets a comment by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  includeDeleted: boolean, Whether to return deleted comments. Deleted comments will not include their original content.
+
+Returns:
+  An object of the form:
+
+    { # A comment on a file.
+      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+      "kind": "drive#comment", # This is always drive#comment.
+      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+      "author": { # Information about a Drive user. # The user who created the comment.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+        "mimeType": "A String", # The MIME type of the quoted content.
+        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+      },
+      "htmlContent": "A String", # The content of the comment with HTML formatting.
+      "id": "A String", # The ID of the comment.
+      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+      "replies": [ # The full list of replies to the comment in chronological order.
+        { # A reply to a comment on a file.
+          "kind": "drive#reply", # This is always drive#reply.
+          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+          "author": { # Information about a Drive user. # The user who created the reply.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+          "htmlContent": "A String", # The content of the reply with HTML formatting.
+          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+              # - resolve
+              # - reopen
+          "id": "A String", # The ID of the reply.
+        },
+      ],
+      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+      "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+    }
+
+ +
+ list(fileId, includeDeleted=None, pageToken=None, startModifiedTime=None, pageSize=None) +
Lists a file's comments.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  includeDeleted: boolean, Whether to include deleted comments. Deleted comments will not include their original content.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+  startModifiedTime: string, The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
+  pageSize: integer, The maximum number of comments to return per page.
+
+Returns:
+  An object of the form:
+
+    { # A list of comments on a file.
+    "nextPageToken": "A String", # The page token for the next page of comments. This will be absent if the end of the comments list has been reached.
+    "kind": "drive#commentList", # This is always drive#commentList.
+    "comments": [ # The page of comments.
+      { # A comment on a file.
+          "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+          "kind": "drive#comment", # This is always drive#comment.
+          "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+          "author": { # Information about a Drive user. # The user who created the comment.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+          "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+            "mimeType": "A String", # The MIME type of the quoted content.
+            "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+          },
+          "htmlContent": "A String", # The content of the comment with HTML formatting.
+          "id": "A String", # The ID of the comment.
+          "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+          "replies": [ # The full list of replies to the comment in chronological order.
+            { # A reply to a comment on a file.
+              "kind": "drive#reply", # This is always drive#reply.
+              "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+              "author": { # Information about a Drive user. # The user who created the reply.
+                "me": True or False, # Whether this user is the requesting user.
+                "kind": "drive#user", # This is always drive#user.
+                "displayName": "A String", # A plain text displayable name for this user.
+                "permissionId": "A String", # The user's ID as visible in Permission resources.
+                "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+                "photoLink": "A String", # A link to the user's profile photo, if available.
+              },
+              "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+              "htmlContent": "A String", # The content of the reply with HTML formatting.
+              "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+              "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+              "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+                  # - resolve
+                  # - reopen
+              "id": "A String", # The ID of the reply.
+            },
+          ],
+          "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+          "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ update(fileId, commentId, body) +
Updates a comment with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A comment on a file.
+    "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+    "kind": "drive#comment", # This is always drive#comment.
+    "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+    "author": { # Information about a Drive user. # The user who created the comment.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+    "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+      "mimeType": "A String", # The MIME type of the quoted content.
+      "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+    },
+    "htmlContent": "A String", # The content of the comment with HTML formatting.
+    "id": "A String", # The ID of the comment.
+    "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+    "replies": [ # The full list of replies to the comment in chronological order.
+      { # A reply to a comment on a file.
+        "kind": "drive#reply", # This is always drive#reply.
+        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+        "author": { # Information about a Drive user. # The user who created the reply.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+        "htmlContent": "A String", # The content of the reply with HTML formatting.
+        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+            # - resolve
+            # - reopen
+        "id": "A String", # The ID of the reply.
+      },
+    ],
+    "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+    "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # A comment on a file.
+      "resolved": True or False, # Whether the comment has been resolved by one of its replies.
+      "kind": "drive#comment", # This is always drive#comment.
+      "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time).
+      "author": { # Information about a Drive user. # The user who created the comment.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+      "deleted": True or False, # Whether the comment has been deleted. A deleted comment has no content.
+      "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
+        "mimeType": "A String", # The MIME type of the quoted content.
+        "value": "A String", # The quoted content itself. This is interpreted as plain text if set through the API.
+      },
+      "htmlContent": "A String", # The content of the comment with HTML formatting.
+      "id": "A String", # The ID of the comment.
+      "content": "A String", # The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
+      "replies": [ # The full list of replies to the comment in chronological order.
+        { # A reply to a comment on a file.
+          "kind": "drive#reply", # This is always drive#reply.
+          "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+          "author": { # Information about a Drive user. # The user who created the reply.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+          "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+          "htmlContent": "A String", # The content of the reply with HTML formatting.
+          "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+          "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+          "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+              # - resolve
+              # - reopen
+          "id": "A String", # The ID of the reply.
+        },
+      ],
+      "createdTime": "A String", # The time at which the comment was created (RFC 3339 date-time).
+      "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html new file mode 100644 index 00000000000..fba0cd7e7e2 --- /dev/null +++ b/docs/dyn/drive_v3.files.html @@ -0,0 +1,1550 @@ + + + +

Drive API . files

+

Instance Methods

+

+ copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None)

+

Creates a copy of a file and applies any requested updates with patch semantics.

+

+ create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None)

+

Creates a new file.

+

+ delete(fileId)

+

Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.

+

+ emptyTrash()

+

Permanently deletes all of the user's trashed files.

+

+ export(fileId, mimeType)

+

Exports a Google Doc to the requested MIME type and returns the exported content.

+

+ export_media(fileId, mimeType)

+

Exports a Google Doc to the requested MIME type and returns the exported content.

+

+ generateIds(count=None, space=None)

+

Generates a set of file IDs which can be provided in create requests.

+

+ get(fileId, acknowledgeAbuse=None)

+

Gets a file's metadata or content by ID.

+

+ get_media(fileId, acknowledgeAbuse=None)

+

Gets a file's metadata or content by ID.

+

+ list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None)

+

Lists or searches files.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ update(fileId, body=None, media_body=None, addParents=None, removeParents=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None)

+

Updates a file's metadata and/or content with patch semantics.

+

+ watch(fileId, body, acknowledgeAbuse=None)

+

Subscribes to changes to a file

+

+ watch_media(fileId, body, acknowledgeAbuse=None)

+

Subscribes to changes to a file

+

Method Details

+
+ copy(fileId, body, keepRevisionForever=None, ignoreDefaultVisibility=None, ocrLanguage=None) +
Creates a copy of a file and applies any requested updates with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The metadata for a file.
+  "mimeType": "A String", # The MIME type of the file.
+      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+  "ownedByMe": True or False, # Whether the user owns the file.
+  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+  "id": "A String", # The ID of the file.
+  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+    "width": 42, # The width of the video in pixels.
+    "durationMillis": "A String", # The duration of the video in milliseconds.
+    "height": 42, # The height of the video in pixels.
+  },
+  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+      # If an unsupported color is specified, the closest color in the palette will be used instead.
+  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "capabilities": { # Capabilities the current user has on the file.
+    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+    "canCopy": True or False, # Whether the user can copy the file.
+    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+    "canEdit": True or False, # Whether the user can edit the file's content.
+    "canComment": True or False, # Whether the user can comment on the file.
+  },
+  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+  "parents": [ # The IDs of the parent folders which contain the file.
+      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+    "A String",
+  ],
+  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+  "shared": True or False, # Whether the file has been shared.
+  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+      "domain": "A String", # The domain to which this permission refers.
+      "displayName": "A String", # A displayable name for users, groups or domains.
+      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+      "kind": "drive#permission", # This is always drive#permission.
+      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+      "role": "A String", # The role granted by this permission. Valid values are:
+          # - owner
+          # - writer
+          # - commenter
+          # - reader
+      "type": "A String", # The type of the grantee. Valid values are:
+          # - user
+          # - group
+          # - domain
+          # - anyone
+      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+    },
+  ],
+  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+  "description": "A String", # A short description of the file.
+  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+  "viewedByMe": True or False, # Whether the file has been viewed by this user.
+  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+    { # Information about a Drive user.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+  ],
+  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+  "imageMediaMetadata": { # Additional metadata about image media, if available.
+    "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+    "exposureTime": 3.14, # The length of the exposure, in seconds.
+    "cameraMake": "A String", # The make of the camera used to create the photo.
+    "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+    "width": 42, # The width of the image in pixels.
+    "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+    "exposureMode": "A String", # The exposure mode used to create the photo.
+    "colorSpace": "A String", # The color space of the photo.
+    "location": { # Geographic location information stored in the image.
+      "latitude": 3.14, # The latitude stored in the image.
+      "altitude": 3.14, # The altitude stored in the image.
+      "longitude": 3.14, # The longitude stored in the image.
+    },
+    "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+    "height": 42, # The height of the image in pixels.
+    "lens": "A String", # The lens used to create the photo.
+    "isoSpeed": 42, # The ISO speed used to create the photo.
+    "meteringMode": "A String", # The metering mode used to create the photo.
+    "flashUsed": True or False, # Whether a flash was used to create the photo.
+    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+    "aperture": 3.14, # The aperture used to create the photo (f-number).
+    "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+    "sensor": "A String", # The type of sensor used to create the photo.
+    "whiteBalance": "A String", # The white balance mode used to create the photo.
+    "cameraModel": "A String", # The model of the camera used to create the photo.
+  },
+  "kind": "drive#file", # This is always drive#file.
+  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+    "A String",
+  ],
+  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+      "mimeType": "A String", # The MIME type of the thumbnail.
+      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+    },
+  },
+  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+  "starred": True or False, # Whether the user has starred the file.
+  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+}
+
+  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
+  ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a file.
+    "mimeType": "A String", # The MIME type of the file.
+        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+    "ownedByMe": True or False, # Whether the user owns the file.
+    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+    "id": "A String", # The ID of the file.
+    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+      "width": 42, # The width of the video in pixels.
+      "durationMillis": "A String", # The duration of the video in milliseconds.
+      "height": 42, # The height of the video in pixels.
+    },
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+        # If an unsupported color is specified, the closest color in the palette will be used instead.
+    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "capabilities": { # Capabilities the current user has on the file.
+      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+      "canCopy": True or False, # Whether the user can copy the file.
+      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+      "canEdit": True or False, # Whether the user can edit the file's content.
+      "canComment": True or False, # Whether the user can comment on the file.
+    },
+    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+    "parents": [ # The IDs of the parent folders which contain the file.
+        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+      "A String",
+    ],
+    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+    "shared": True or False, # Whether the file has been shared.
+    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+        "domain": "A String", # The domain to which this permission refers.
+        "displayName": "A String", # A displayable name for users, groups or domains.
+        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+        "kind": "drive#permission", # This is always drive#permission.
+        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+        "role": "A String", # The role granted by this permission. Valid values are:
+            # - owner
+            # - writer
+            # - commenter
+            # - reader
+        "type": "A String", # The type of the grantee. Valid values are:
+            # - user
+            # - group
+            # - domain
+            # - anyone
+        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+      },
+    ],
+    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+    "description": "A String", # A short description of the file.
+    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+    "viewedByMe": True or False, # Whether the file has been viewed by this user.
+    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+      { # Information about a Drive user.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+    ],
+    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+    "imageMediaMetadata": { # Additional metadata about image media, if available.
+      "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+      "exposureTime": 3.14, # The length of the exposure, in seconds.
+      "cameraMake": "A String", # The make of the camera used to create the photo.
+      "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+      "width": 42, # The width of the image in pixels.
+      "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+      "exposureMode": "A String", # The exposure mode used to create the photo.
+      "colorSpace": "A String", # The color space of the photo.
+      "location": { # Geographic location information stored in the image.
+        "latitude": 3.14, # The latitude stored in the image.
+        "altitude": 3.14, # The altitude stored in the image.
+        "longitude": 3.14, # The longitude stored in the image.
+      },
+      "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+      "height": 42, # The height of the image in pixels.
+      "lens": "A String", # The lens used to create the photo.
+      "isoSpeed": 42, # The ISO speed used to create the photo.
+      "meteringMode": "A String", # The metering mode used to create the photo.
+      "flashUsed": True or False, # Whether a flash was used to create the photo.
+      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+      "aperture": 3.14, # The aperture used to create the photo (f-number).
+      "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+      "sensor": "A String", # The type of sensor used to create the photo.
+      "whiteBalance": "A String", # The white balance mode used to create the photo.
+      "cameraModel": "A String", # The model of the camera used to create the photo.
+    },
+    "kind": "drive#file", # This is always drive#file.
+    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+      "A String",
+    ],
+    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+        "mimeType": "A String", # The MIME type of the thumbnail.
+        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+      },
+    },
+    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+    "starred": True or False, # Whether the user has starred the file.
+    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+  }
+
+ +
+ create(body=None, media_body=None, keepRevisionForever=None, useContentAsIndexableText=None, ignoreDefaultVisibility=None, ocrLanguage=None) +
Creates a new file.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The metadata for a file.
+  "mimeType": "A String", # The MIME type of the file.
+      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+  "ownedByMe": True or False, # Whether the user owns the file.
+  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+  "id": "A String", # The ID of the file.
+  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+    "width": 42, # The width of the video in pixels.
+    "durationMillis": "A String", # The duration of the video in milliseconds.
+    "height": 42, # The height of the video in pixels.
+  },
+  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+      # If an unsupported color is specified, the closest color in the palette will be used instead.
+  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "capabilities": { # Capabilities the current user has on the file.
+    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+    "canCopy": True or False, # Whether the user can copy the file.
+    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+    "canEdit": True or False, # Whether the user can edit the file's content.
+    "canComment": True or False, # Whether the user can comment on the file.
+  },
+  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+  "parents": [ # The IDs of the parent folders which contain the file.
+      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+    "A String",
+  ],
+  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+  "shared": True or False, # Whether the file has been shared.
+  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+      "domain": "A String", # The domain to which this permission refers.
+      "displayName": "A String", # A displayable name for users, groups or domains.
+      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+      "kind": "drive#permission", # This is always drive#permission.
+      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+      "role": "A String", # The role granted by this permission. Valid values are:
+          # - owner
+          # - writer
+          # - commenter
+          # - reader
+      "type": "A String", # The type of the grantee. Valid values are:
+          # - user
+          # - group
+          # - domain
+          # - anyone
+      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+    },
+  ],
+  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+  "description": "A String", # A short description of the file.
+  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+  "viewedByMe": True or False, # Whether the file has been viewed by this user.
+  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+    { # Information about a Drive user.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+  ],
+  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+  "imageMediaMetadata": { # Additional metadata about image media, if available.
+    "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+    "exposureTime": 3.14, # The length of the exposure, in seconds.
+    "cameraMake": "A String", # The make of the camera used to create the photo.
+    "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+    "width": 42, # The width of the image in pixels.
+    "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+    "exposureMode": "A String", # The exposure mode used to create the photo.
+    "colorSpace": "A String", # The color space of the photo.
+    "location": { # Geographic location information stored in the image.
+      "latitude": 3.14, # The latitude stored in the image.
+      "altitude": 3.14, # The altitude stored in the image.
+      "longitude": 3.14, # The longitude stored in the image.
+    },
+    "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+    "height": 42, # The height of the image in pixels.
+    "lens": "A String", # The lens used to create the photo.
+    "isoSpeed": 42, # The ISO speed used to create the photo.
+    "meteringMode": "A String", # The metering mode used to create the photo.
+    "flashUsed": True or False, # Whether a flash was used to create the photo.
+    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+    "aperture": 3.14, # The aperture used to create the photo (f-number).
+    "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+    "sensor": "A String", # The type of sensor used to create the photo.
+    "whiteBalance": "A String", # The white balance mode used to create the photo.
+    "cameraModel": "A String", # The model of the camera used to create the photo.
+  },
+  "kind": "drive#file", # This is always drive#file.
+  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+    "A String",
+  ],
+  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+      "mimeType": "A String", # The MIME type of the thumbnail.
+      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+    },
+  },
+  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+  "starred": True or False, # Whether the user has starred the file.
+  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
+  useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
+  ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
+  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a file.
+    "mimeType": "A String", # The MIME type of the file.
+        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+    "ownedByMe": True or False, # Whether the user owns the file.
+    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+    "id": "A String", # The ID of the file.
+    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+      "width": 42, # The width of the video in pixels.
+      "durationMillis": "A String", # The duration of the video in milliseconds.
+      "height": 42, # The height of the video in pixels.
+    },
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+        # If an unsupported color is specified, the closest color in the palette will be used instead.
+    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "capabilities": { # Capabilities the current user has on the file.
+      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+      "canCopy": True or False, # Whether the user can copy the file.
+      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+      "canEdit": True or False, # Whether the user can edit the file's content.
+      "canComment": True or False, # Whether the user can comment on the file.
+    },
+    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+    "parents": [ # The IDs of the parent folders which contain the file.
+        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+      "A String",
+    ],
+    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+    "shared": True or False, # Whether the file has been shared.
+    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+        "domain": "A String", # The domain to which this permission refers.
+        "displayName": "A String", # A displayable name for users, groups or domains.
+        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+        "kind": "drive#permission", # This is always drive#permission.
+        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+        "role": "A String", # The role granted by this permission. Valid values are:
+            # - owner
+            # - writer
+            # - commenter
+            # - reader
+        "type": "A String", # The type of the grantee. Valid values are:
+            # - user
+            # - group
+            # - domain
+            # - anyone
+        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+      },
+    ],
+    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+    "description": "A String", # A short description of the file.
+    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+    "viewedByMe": True or False, # Whether the file has been viewed by this user.
+    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+      { # Information about a Drive user.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+    ],
+    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+    "imageMediaMetadata": { # Additional metadata about image media, if available.
+      "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+      "exposureTime": 3.14, # The length of the exposure, in seconds.
+      "cameraMake": "A String", # The make of the camera used to create the photo.
+      "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+      "width": 42, # The width of the image in pixels.
+      "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+      "exposureMode": "A String", # The exposure mode used to create the photo.
+      "colorSpace": "A String", # The color space of the photo.
+      "location": { # Geographic location information stored in the image.
+        "latitude": 3.14, # The latitude stored in the image.
+        "altitude": 3.14, # The altitude stored in the image.
+        "longitude": 3.14, # The longitude stored in the image.
+      },
+      "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+      "height": 42, # The height of the image in pixels.
+      "lens": "A String", # The lens used to create the photo.
+      "isoSpeed": 42, # The ISO speed used to create the photo.
+      "meteringMode": "A String", # The metering mode used to create the photo.
+      "flashUsed": True or False, # Whether a flash was used to create the photo.
+      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+      "aperture": 3.14, # The aperture used to create the photo (f-number).
+      "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+      "sensor": "A String", # The type of sensor used to create the photo.
+      "whiteBalance": "A String", # The white balance mode used to create the photo.
+      "cameraModel": "A String", # The model of the camera used to create the photo.
+    },
+    "kind": "drive#file", # This is always drive#file.
+    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+      "A String",
+    ],
+    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+        "mimeType": "A String", # The MIME type of the thumbnail.
+        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+      },
+    },
+    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+    "starred": True or False, # Whether the user has starred the file.
+    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+  }
+
+ +
+ delete(fileId) +
Permanently deletes a file owned by the user without moving it to the trash. If the target is a folder, all descendants owned by the user are also deleted.
+
+Args:
+  fileId: string, The ID of the file. (required)
+
+
+ +
+ emptyTrash() +
Permanently deletes all of the user's trashed files.
+
+Args:
+
+
+ +
+ export(fileId, mimeType) +
Exports a Google Doc to the requested MIME type and returns the exported content.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  mimeType: string, The MIME type of the format requested for this export. (required)
+
+
+ +
+ export_media(fileId, mimeType) +
Exports a Google Doc to the requested MIME type and returns the exported content.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  mimeType: string, The MIME type of the format requested for this export. (required)
+
+
+ +
+ generateIds(count=None, space=None) +
Generates a set of file IDs which can be provided in create requests.
+
+Args:
+  count: integer, The number of IDs to return.
+  space: string, The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
+
+Returns:
+  An object of the form:
+
+    { # A list of generated file IDs which can be provided in create requests.
+    "kind": "drive#generatedIds", # This is always drive#generatedIds
+    "ids": [ # The IDs generated for the requesting user in the specified space.
+      "A String",
+    ],
+    "space": "A String", # The type of file that can be created with these IDs.
+  }
+
+ +
+ get(fileId, acknowledgeAbuse=None) +
Gets a file's metadata or content by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a file.
+    "mimeType": "A String", # The MIME type of the file.
+        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+    "ownedByMe": True or False, # Whether the user owns the file.
+    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+    "id": "A String", # The ID of the file.
+    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+      "width": 42, # The width of the video in pixels.
+      "durationMillis": "A String", # The duration of the video in milliseconds.
+      "height": 42, # The height of the video in pixels.
+    },
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+        # If an unsupported color is specified, the closest color in the palette will be used instead.
+    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "capabilities": { # Capabilities the current user has on the file.
+      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+      "canCopy": True or False, # Whether the user can copy the file.
+      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+      "canEdit": True or False, # Whether the user can edit the file's content.
+      "canComment": True or False, # Whether the user can comment on the file.
+    },
+    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+    "parents": [ # The IDs of the parent folders which contain the file.
+        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+      "A String",
+    ],
+    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+    "shared": True or False, # Whether the file has been shared.
+    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+        "domain": "A String", # The domain to which this permission refers.
+        "displayName": "A String", # A displayable name for users, groups or domains.
+        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+        "kind": "drive#permission", # This is always drive#permission.
+        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+        "role": "A String", # The role granted by this permission. Valid values are:
+            # - owner
+            # - writer
+            # - commenter
+            # - reader
+        "type": "A String", # The type of the grantee. Valid values are:
+            # - user
+            # - group
+            # - domain
+            # - anyone
+        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+      },
+    ],
+    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+    "description": "A String", # A short description of the file.
+    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+    "viewedByMe": True or False, # Whether the file has been viewed by this user.
+    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+      { # Information about a Drive user.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+    ],
+    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+    "imageMediaMetadata": { # Additional metadata about image media, if available.
+      "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+      "exposureTime": 3.14, # The length of the exposure, in seconds.
+      "cameraMake": "A String", # The make of the camera used to create the photo.
+      "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+      "width": 42, # The width of the image in pixels.
+      "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+      "exposureMode": "A String", # The exposure mode used to create the photo.
+      "colorSpace": "A String", # The color space of the photo.
+      "location": { # Geographic location information stored in the image.
+        "latitude": 3.14, # The latitude stored in the image.
+        "altitude": 3.14, # The altitude stored in the image.
+        "longitude": 3.14, # The longitude stored in the image.
+      },
+      "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+      "height": 42, # The height of the image in pixels.
+      "lens": "A String", # The lens used to create the photo.
+      "isoSpeed": 42, # The ISO speed used to create the photo.
+      "meteringMode": "A String", # The metering mode used to create the photo.
+      "flashUsed": True or False, # Whether a flash was used to create the photo.
+      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+      "aperture": 3.14, # The aperture used to create the photo (f-number).
+      "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+      "sensor": "A String", # The type of sensor used to create the photo.
+      "whiteBalance": "A String", # The white balance mode used to create the photo.
+      "cameraModel": "A String", # The model of the camera used to create the photo.
+    },
+    "kind": "drive#file", # This is always drive#file.
+    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+      "A String",
+    ],
+    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+        "mimeType": "A String", # The MIME type of the thumbnail.
+        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+      },
+    },
+    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+    "starred": True or False, # Whether the user has starred the file.
+    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+  }
+
+ +
+ get_media(fileId, acknowledgeAbuse=None) +
Gets a file's metadata or content by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(orderBy=None, q=None, pageSize=None, pageToken=None, spaces=None, corpus=None) +
Lists or searches files.
+
+Args:
+  orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
+  q: string, A query for filtering the file results. See the "Search for Files" guide for supported syntax.
+  pageSize: integer, The maximum number of files to return per page.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+  spaces: string, A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
+  corpus: string, The source of files to list.
+    Allowed values
+      domain - Files shared to the user's domain.
+      user - Files owned by or shared to the user.
+
+Returns:
+  An object of the form:
+
+    { # A list of files.
+    "files": [ # The page of files.
+      { # The metadata for a file.
+        "mimeType": "A String", # The MIME type of the file.
+            # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+            # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+        "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+        "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+        "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+        "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+        "ownedByMe": True or False, # Whether the user owns the file.
+        "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+        "id": "A String", # The ID of the file.
+        "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+        "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+          "width": 42, # The width of the video in pixels.
+          "durationMillis": "A String", # The duration of the video in milliseconds.
+          "height": 42, # The height of the video in pixels.
+        },
+        "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+            # If an unsupported color is specified, the closest color in the palette will be used instead.
+        "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+            # Entries with null values are cleared in update and copy requests.
+          "a_key": "A String",
+        },
+        "capabilities": { # Capabilities the current user has on the file.
+          "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+          "canCopy": True or False, # Whether the user can copy the file.
+          "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+          "canEdit": True or False, # Whether the user can edit the file's content.
+          "canComment": True or False, # Whether the user can comment on the file.
+        },
+        "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+        "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+        "parents": [ # The IDs of the parent folders which contain the file.
+            # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+          "A String",
+        ],
+        "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+        "shared": True or False, # Whether the file has been shared.
+        "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+          { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+            "domain": "A String", # The domain to which this permission refers.
+            "displayName": "A String", # A displayable name for users, groups or domains.
+            "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+            "kind": "drive#permission", # This is always drive#permission.
+            "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+            "role": "A String", # The role granted by this permission. Valid values are:
+                # - owner
+                # - writer
+                # - commenter
+                # - reader
+            "type": "A String", # The type of the grantee. Valid values are:
+                # - user
+                # - group
+                # - domain
+                # - anyone
+            "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+          },
+        ],
+        "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+            # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+        "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+        "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+        "description": "A String", # A short description of the file.
+        "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+            # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+        "viewedByMe": True or False, # Whether the file has been viewed by this user.
+        "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+          { # Information about a Drive user.
+            "me": True or False, # Whether this user is the requesting user.
+            "kind": "drive#user", # This is always drive#user.
+            "displayName": "A String", # A plain text displayable name for this user.
+            "permissionId": "A String", # The user's ID as visible in Permission resources.
+            "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+            "photoLink": "A String", # A link to the user's profile photo, if available.
+          },
+        ],
+        "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+        "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+        "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+            # Entries with null values are cleared in update and copy requests.
+          "a_key": "A String",
+        },
+        "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+        "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+        "imageMediaMetadata": { # Additional metadata about image media, if available.
+          "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+          "exposureTime": 3.14, # The length of the exposure, in seconds.
+          "cameraMake": "A String", # The make of the camera used to create the photo.
+          "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+          "width": 42, # The width of the image in pixels.
+          "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+          "exposureMode": "A String", # The exposure mode used to create the photo.
+          "colorSpace": "A String", # The color space of the photo.
+          "location": { # Geographic location information stored in the image.
+            "latitude": 3.14, # The latitude stored in the image.
+            "altitude": 3.14, # The altitude stored in the image.
+            "longitude": 3.14, # The longitude stored in the image.
+          },
+          "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+          "height": 42, # The height of the image in pixels.
+          "lens": "A String", # The lens used to create the photo.
+          "isoSpeed": 42, # The ISO speed used to create the photo.
+          "meteringMode": "A String", # The metering mode used to create the photo.
+          "flashUsed": True or False, # Whether a flash was used to create the photo.
+          "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+          "aperture": 3.14, # The aperture used to create the photo (f-number).
+          "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+          "sensor": "A String", # The type of sensor used to create the photo.
+          "whiteBalance": "A String", # The white balance mode used to create the photo.
+          "cameraModel": "A String", # The model of the camera used to create the photo.
+        },
+        "kind": "drive#file", # This is always drive#file.
+        "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+        "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+        "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+          "A String",
+        ],
+        "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+        "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+          "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+          "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+            "mimeType": "A String", # The MIME type of the thumbnail.
+            "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+          },
+        },
+        "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+        "starred": True or False, # Whether the user has starred the file.
+        "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+      },
+    ],
+    "nextPageToken": "A String", # The page token for the next page of files. This will be absent if the end of the files list has been reached.
+    "kind": "drive#fileList", # This is always drive#fileList.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ update(fileId, body=None, media_body=None, addParents=None, removeParents=None, useContentAsIndexableText=None, keepRevisionForever=None, ocrLanguage=None) +
Updates a file's metadata and/or content with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The metadata for a file.
+  "mimeType": "A String", # The MIME type of the file.
+      # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+      # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+  "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+  "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+  "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+  "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+  "ownedByMe": True or False, # Whether the user owns the file.
+  "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+  "id": "A String", # The ID of the file.
+  "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+  "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+    "width": 42, # The width of the video in pixels.
+    "durationMillis": "A String", # The duration of the video in milliseconds.
+    "height": 42, # The height of the video in pixels.
+  },
+  "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+      # If an unsupported color is specified, the closest color in the palette will be used instead.
+  "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "capabilities": { # Capabilities the current user has on the file.
+    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+    "canCopy": True or False, # Whether the user can copy the file.
+    "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+    "canEdit": True or False, # Whether the user can edit the file's content.
+    "canComment": True or False, # Whether the user can comment on the file.
+  },
+  "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+  "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+  "parents": [ # The IDs of the parent folders which contain the file.
+      # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+    "A String",
+  ],
+  "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+  "shared": True or False, # Whether the file has been shared.
+  "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+      "domain": "A String", # The domain to which this permission refers.
+      "displayName": "A String", # A displayable name for users, groups or domains.
+      "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+      "kind": "drive#permission", # This is always drive#permission.
+      "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+      "role": "A String", # The role granted by this permission. Valid values are:
+          # - owner
+          # - writer
+          # - commenter
+          # - reader
+      "type": "A String", # The type of the grantee. Valid values are:
+          # - user
+          # - group
+          # - domain
+          # - anyone
+      "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+    },
+  ],
+  "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+      # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+  "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+  "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+  "description": "A String", # A short description of the file.
+  "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+      # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+  "viewedByMe": True or False, # Whether the file has been viewed by this user.
+  "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+    { # Information about a Drive user.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+  ],
+  "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+  "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+  "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+      # Entries with null values are cleared in update and copy requests.
+    "a_key": "A String",
+  },
+  "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+  "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+  "imageMediaMetadata": { # Additional metadata about image media, if available.
+    "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+    "exposureTime": 3.14, # The length of the exposure, in seconds.
+    "cameraMake": "A String", # The make of the camera used to create the photo.
+    "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+    "width": 42, # The width of the image in pixels.
+    "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+    "exposureMode": "A String", # The exposure mode used to create the photo.
+    "colorSpace": "A String", # The color space of the photo.
+    "location": { # Geographic location information stored in the image.
+      "latitude": 3.14, # The latitude stored in the image.
+      "altitude": 3.14, # The altitude stored in the image.
+      "longitude": 3.14, # The longitude stored in the image.
+    },
+    "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+    "height": 42, # The height of the image in pixels.
+    "lens": "A String", # The lens used to create the photo.
+    "isoSpeed": 42, # The ISO speed used to create the photo.
+    "meteringMode": "A String", # The metering mode used to create the photo.
+    "flashUsed": True or False, # Whether a flash was used to create the photo.
+    "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+    "aperture": 3.14, # The aperture used to create the photo (f-number).
+    "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+    "sensor": "A String", # The type of sensor used to create the photo.
+    "whiteBalance": "A String", # The white balance mode used to create the photo.
+    "cameraModel": "A String", # The model of the camera used to create the photo.
+  },
+  "kind": "drive#file", # This is always drive#file.
+  "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+  "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+  "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+    "A String",
+  ],
+  "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+  "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+    "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+    "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+      "mimeType": "A String", # The MIME type of the thumbnail.
+      "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+    },
+  },
+  "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+  "starred": True or False, # Whether the user has starred the file.
+  "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  addParents: string, A comma-separated list of parent IDs to add.
+  removeParents: string, A comma-separated list of parent IDs to remove.
+  useContentAsIndexableText: boolean, Whether to use the uploaded content as indexable text.
+  keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Drive.
+  ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code).
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a file.
+    "mimeType": "A String", # The MIME type of the file.
+        # Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded.
+        # If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.
+    "modifiedByMeTime": "A String", # The last time the file was modified by the user (RFC 3339 date-time).
+    "thumbnailLink": "A String", # A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
+    "explicitlyTrashed": True or False, # Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
+    "writersCanShare": True or False, # Whether users with only writer permission can modify the file's permissions.
+    "ownedByMe": True or False, # Whether the user owns the file.
+    "viewedByMeTime": "A String", # The last time the file was viewed by the user (RFC 3339 date-time).
+    "id": "A String", # The ID of the file.
+    "sharingUser": { # Information about a Drive user. # The user who shared the file with the requesting user, if applicable.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "size": "A String", # The size of the file's content in bytes. This is only applicable to files with binary content in Drive.
+    "videoMediaMetadata": { # Additional metadata about video media. This may not be available immediately upon upload.
+      "width": 42, # The width of the video in pixels.
+      "durationMillis": "A String", # The duration of the video in milliseconds.
+      "height": 42, # The height of the video in pixels.
+    },
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "folderColorRgb": "A String", # The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource.
+        # If an unsupported color is specified, the closest color in the palette will be used instead.
+    "appProperties": { # A collection of arbitrary key-value pairs which are private to the requesting app.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "capabilities": { # Capabilities the current user has on the file.
+      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of the file.
+      "canCopy": True or False, # Whether the user can copy the file.
+      "canShare": True or False, # Whether the user can modify the file's permissions and sharing settings.
+      "canEdit": True or False, # Whether the user can edit the file's content.
+      "canComment": True or False, # Whether the user can comment on the file.
+    },
+    "webViewLink": "A String", # A link for opening the file in a relevant Google editor or viewer in a browser.
+    "version": "A String", # A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.
+    "parents": [ # The IDs of the parent folders which contain the file.
+        # If not specified as part of a create request, the file will be placed directly in the My Drive folder. Update requests must use the addParents and removeParents parameters to modify the values.
+      "A String",
+    ],
+    "sharedWithMeTime": "A String", # The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
+    "shared": True or False, # Whether the file has been shared.
+    "permissions": [ # The full list of permissions for the file. This is only available if the requesting user can share the file.
+      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+        "domain": "A String", # The domain to which this permission refers.
+        "displayName": "A String", # A displayable name for users, groups or domains.
+        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+        "kind": "drive#permission", # This is always drive#permission.
+        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+        "role": "A String", # The role granted by this permission. Valid values are:
+            # - owner
+            # - writer
+            # - commenter
+            # - reader
+        "type": "A String", # The type of the grantee. Valid values are:
+            # - user
+            # - group
+            # - domain
+            # - anyone
+        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+      },
+    ],
+    "fullFileExtension": "A String", # The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Drive.
+        # This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.
+    "originalFilename": "A String", # The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Drive.
+    "viewersCanCopyContent": True or False, # Whether users with only reader or commenter permission can copy the file's content. This affects copy, download, and print operations.
+    "description": "A String", # A short description of the file.
+    "modifiedTime": "A String", # The last time the file was modified by anyone (RFC 3339 date-time).
+        # Note that setting modifiedTime will also update modifiedByMeTime for the user.
+    "viewedByMe": True or False, # Whether the file has been viewed by this user.
+    "owners": [ # The owners of the file. Currently, only certain legacy files may have more than one owner.
+      { # Information about a Drive user.
+        "me": True or False, # Whether this user is the requesting user.
+        "kind": "drive#user", # This is always drive#user.
+        "displayName": "A String", # A plain text displayable name for this user.
+        "permissionId": "A String", # The user's ID as visible in Permission resources.
+        "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+      },
+    ],
+    "createdTime": "A String", # The time at which the file was created (RFC 3339 date-time).
+    "quotaBytesUsed": "A String", # The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.
+    "properties": { # A collection of arbitrary key-value pairs which are visible to all apps.
+        # Entries with null values are cleared in update and copy requests.
+      "a_key": "A String",
+    },
+    "md5Checksum": "A String", # The MD5 checksum for the content of the file. This is only applicable to files with binary content in Drive.
+    "iconLink": "A String", # A static, unauthenticated link to the file's icon.
+    "imageMediaMetadata": { # Additional metadata about image media, if available.
+      "exposureBias": 3.14, # The exposure bias of the photo (APEX value).
+      "exposureTime": 3.14, # The length of the exposure, in seconds.
+      "cameraMake": "A String", # The make of the camera used to create the photo.
+      "maxApertureValue": 3.14, # The smallest f-number of the lens at the focal length used to create the photo (APEX value).
+      "width": 42, # The width of the image in pixels.
+      "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+      "exposureMode": "A String", # The exposure mode used to create the photo.
+      "colorSpace": "A String", # The color space of the photo.
+      "location": { # Geographic location information stored in the image.
+        "latitude": 3.14, # The latitude stored in the image.
+        "altitude": 3.14, # The altitude stored in the image.
+        "longitude": 3.14, # The longitude stored in the image.
+      },
+      "subjectDistance": 42, # The distance to the subject of the photo, in meters.
+      "height": 42, # The height of the image in pixels.
+      "lens": "A String", # The lens used to create the photo.
+      "isoSpeed": 42, # The ISO speed used to create the photo.
+      "meteringMode": "A String", # The metering mode used to create the photo.
+      "flashUsed": True or False, # Whether a flash was used to create the photo.
+      "time": "A String", # The date and time the photo was taken (EXIF DateTime).
+      "aperture": 3.14, # The aperture used to create the photo (f-number).
+      "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+      "sensor": "A String", # The type of sensor used to create the photo.
+      "whiteBalance": "A String", # The white balance mode used to create the photo.
+      "cameraModel": "A String", # The model of the camera used to create the photo.
+    },
+    "kind": "drive#file", # This is always drive#file.
+    "name": "A String", # The name of the file. This is not necessarily unique within a folder.
+    "webContentLink": "A String", # A link for downloading the content of the file in a browser. This is only available for files with binary content in Drive.
+    "spaces": [ # The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
+      "A String",
+    ],
+    "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.
+    "contentHints": { # Additional information about the content of the file. These fields are never populated in responses.
+      "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements.
+      "thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
+        "mimeType": "A String", # The MIME type of the thumbnail.
+        "image": "A String", # The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
+      },
+    },
+    "fileExtension": "A String", # The final component of fullFileExtension. This is only available for files with binary content in Drive.
+    "starred": True or False, # Whether the user has starred the file.
+    "headRevisionId": "A String", # The ID of the file's head revision. This is currently only available for files with binary content in Drive.
+  }
+
+ +
+ watch(fileId, body, acknowledgeAbuse=None) +
Subscribes to changes to a file
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+    "resourceUri": "A String", # A version-specific identifier for the watched resource.
+    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+    "params": { # Additional parameters controlling delivery channel behavior. Optional.
+      "a_key": "A String", # Declares a new parameter by name.
+    },
+    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+    "address": "A String", # The address where notifications are delivered for this channel.
+    "type": "A String", # The type of delivery mechanism used for this channel.
+    "id": "A String", # A UUID or similar unique string that identifies this channel.
+  }
+
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  An object of the form:
+
+    { # An notification channel used to watch for resource changes.
+      "resourceUri": "A String", # A version-specific identifier for the watched resource.
+      "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+      "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+      "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+      "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+      "params": { # Additional parameters controlling delivery channel behavior. Optional.
+        "a_key": "A String", # Declares a new parameter by name.
+      },
+      "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+      "address": "A String", # The address where notifications are delivered for this channel.
+      "type": "A String", # The type of delivery mechanism used for this channel.
+      "id": "A String", # A UUID or similar unique string that identifies this channel.
+    }
+
+ +
+ watch_media(fileId, body, acknowledgeAbuse=None) +
Subscribes to changes to a file
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # An notification channel used to watch for resource changes.
+    "resourceUri": "A String", # A version-specific identifier for the watched resource.
+    "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
+    "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
+    "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
+    "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
+    "params": { # Additional parameters controlling delivery channel behavior. Optional.
+      "a_key": "A String", # Declares a new parameter by name.
+    },
+    "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
+    "address": "A String", # The address where notifications are delivered for this channel.
+    "type": "A String", # The type of delivery mechanism used for this channel.
+    "id": "A String", # A UUID or similar unique string that identifies this channel.
+  }
+
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  The media object as a string.
+
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.html b/docs/dyn/drive_v3.html new file mode 100644 index 00000000000..d1cc6b02f7d --- /dev/null +++ b/docs/dyn/drive_v3.html @@ -0,0 +1,138 @@ + + + +

Drive API

+

Instance Methods

+

+ about() +

+

Returns the about Resource.

+ +

+ changes() +

+

Returns the changes Resource.

+ +

+ channels() +

+

Returns the channels Resource.

+ +

+ comments() +

+

Returns the comments Resource.

+ +

+ files() +

+

Returns the files Resource.

+ +

+ permissions() +

+

Returns the permissions Resource.

+ +

+ replies() +

+

Returns the replies Resource.

+ +

+ revisions() +

+

Returns the revisions Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.permissions.html b/docs/dyn/drive_v3.permissions.html new file mode 100644 index 00000000000..d2b3764ad6a --- /dev/null +++ b/docs/dyn/drive_v3.permissions.html @@ -0,0 +1,284 @@ + + + +

Drive API . permissions

+

Instance Methods

+

+ create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None)

+

Creates a permission for a file.

+

+ delete(fileId, permissionId)

+

Deletes a permission.

+

+ get(fileId, permissionId)

+

Gets a permission by ID.

+

+ list(fileId)

+

Lists a file's permissions.

+

+ update(fileId, permissionId, body, transferOwnership=None)

+

Updates a permission with patch semantics.

+

Method Details

+
+ create(fileId, body, sendNotificationEmail=None, transferOwnership=None, emailMessage=None) +
Creates a permission for a file.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+  "domain": "A String", # The domain to which this permission refers.
+  "displayName": "A String", # A displayable name for users, groups or domains.
+  "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+  "kind": "drive#permission", # This is always drive#permission.
+  "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+  "photoLink": "A String", # A link to the user's profile photo, if available.
+  "role": "A String", # The role granted by this permission. Valid values are:
+      # - owner
+      # - writer
+      # - commenter
+      # - reader
+  "type": "A String", # The type of the grantee. Valid values are:
+      # - user
+      # - group
+      # - domain
+      # - anyone
+  "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+}
+
+  sendNotificationEmail: boolean, Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
+  transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
+  emailMessage: string, A custom message to include in the notification email.
+
+Returns:
+  An object of the form:
+
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+    "domain": "A String", # The domain to which this permission refers.
+    "displayName": "A String", # A displayable name for users, groups or domains.
+    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+    "kind": "drive#permission", # This is always drive#permission.
+    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+    "role": "A String", # The role granted by this permission. Valid values are:
+        # - owner
+        # - writer
+        # - commenter
+        # - reader
+    "type": "A String", # The type of the grantee. Valid values are:
+        # - user
+        # - group
+        # - domain
+        # - anyone
+    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+  }
+
+ +
+ delete(fileId, permissionId) +
Deletes a permission.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  permissionId: string, The ID of the permission. (required)
+
+
+ +
+ get(fileId, permissionId) +
Gets a permission by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  permissionId: string, The ID of the permission. (required)
+
+Returns:
+  An object of the form:
+
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+    "domain": "A String", # The domain to which this permission refers.
+    "displayName": "A String", # A displayable name for users, groups or domains.
+    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+    "kind": "drive#permission", # This is always drive#permission.
+    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+    "role": "A String", # The role granted by this permission. Valid values are:
+        # - owner
+        # - writer
+        # - commenter
+        # - reader
+    "type": "A String", # The type of the grantee. Valid values are:
+        # - user
+        # - group
+        # - domain
+        # - anyone
+    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+  }
+
+ +
+ list(fileId) +
Lists a file's permissions.
+
+Args:
+  fileId: string, The ID of the file. (required)
+
+Returns:
+  An object of the form:
+
+    { # A list of permissions for a file.
+    "kind": "drive#permissionList", # This is always drive#permissionList.
+    "permissions": [ # The full list of permissions.
+      { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+        "domain": "A String", # The domain to which this permission refers.
+        "displayName": "A String", # A displayable name for users, groups or domains.
+        "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+        "kind": "drive#permission", # This is always drive#permission.
+        "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+        "photoLink": "A String", # A link to the user's profile photo, if available.
+        "role": "A String", # The role granted by this permission. Valid values are:
+            # - owner
+            # - writer
+            # - commenter
+            # - reader
+        "type": "A String", # The type of the grantee. Valid values are:
+            # - user
+            # - group
+            # - domain
+            # - anyone
+        "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+      },
+    ],
+  }
+
+ +
+ update(fileId, permissionId, body, transferOwnership=None) +
Updates a permission with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  permissionId: string, The ID of the permission. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+  "domain": "A String", # The domain to which this permission refers.
+  "displayName": "A String", # A displayable name for users, groups or domains.
+  "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+  "kind": "drive#permission", # This is always drive#permission.
+  "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+  "photoLink": "A String", # A link to the user's profile photo, if available.
+  "role": "A String", # The role granted by this permission. Valid values are:
+      # - owner
+      # - writer
+      # - commenter
+      # - reader
+  "type": "A String", # The type of the grantee. Valid values are:
+      # - user
+      # - group
+      # - domain
+      # - anyone
+  "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+}
+
+  transferOwnership: boolean, Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
+
+Returns:
+  An object of the form:
+
+    { # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
+    "domain": "A String", # The domain to which this permission refers.
+    "displayName": "A String", # A displayable name for users, groups or domains.
+    "allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
+    "kind": "drive#permission", # This is always drive#permission.
+    "emailAddress": "A String", # The email address of the user or group to which this permission refers.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+    "role": "A String", # The role granted by this permission. Valid values are:
+        # - owner
+        # - writer
+        # - commenter
+        # - reader
+    "type": "A String", # The type of the grantee. Valid values are:
+        # - user
+        # - group
+        # - domain
+        # - anyone
+    "id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.replies.html b/docs/dyn/drive_v3.replies.html new file mode 100644 index 00000000000..4a0bd89d25b --- /dev/null +++ b/docs/dyn/drive_v3.replies.html @@ -0,0 +1,313 @@ + + + +

Drive API . replies

+

Instance Methods

+

+ create(fileId, commentId, body)

+

Creates a new reply to a comment.

+

+ delete(fileId, commentId, replyId)

+

Deletes a reply.

+

+ get(fileId, commentId, replyId, includeDeleted=None)

+

Gets a reply by ID.

+

+ list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None)

+

Lists a comment's replies.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ update(fileId, commentId, replyId, body)

+

Updates a reply with patch semantics.

+

Method Details

+
+ create(fileId, commentId, body) +
Creates a new reply to a comment.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A reply to a comment on a file.
+  "kind": "drive#reply", # This is always drive#reply.
+  "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+  "author": { # Information about a Drive user. # The user who created the reply.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+  "htmlContent": "A String", # The content of the reply with HTML formatting.
+  "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+  "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+  "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+      # - resolve
+      # - reopen
+  "id": "A String", # The ID of the reply.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # A reply to a comment on a file.
+    "kind": "drive#reply", # This is always drive#reply.
+    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+    "author": { # Information about a Drive user. # The user who created the reply.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+    "htmlContent": "A String", # The content of the reply with HTML formatting.
+    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+        # - resolve
+        # - reopen
+    "id": "A String", # The ID of the reply.
+  }
+
+ +
+ delete(fileId, commentId, replyId) +
Deletes a reply.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  replyId: string, The ID of the reply. (required)
+
+
+ +
+ get(fileId, commentId, replyId, includeDeleted=None) +
Gets a reply by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  replyId: string, The ID of the reply. (required)
+  includeDeleted: boolean, Whether to return deleted replies. Deleted replies will not include their original content.
+
+Returns:
+  An object of the form:
+
+    { # A reply to a comment on a file.
+    "kind": "drive#reply", # This is always drive#reply.
+    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+    "author": { # Information about a Drive user. # The user who created the reply.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+    "htmlContent": "A String", # The content of the reply with HTML formatting.
+    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+        # - resolve
+        # - reopen
+    "id": "A String", # The ID of the reply.
+  }
+
+ +
+ list(fileId, commentId, includeDeleted=None, pageToken=None, pageSize=None) +
Lists a comment's replies.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  includeDeleted: boolean, Whether to include deleted replies. Deleted replies will not include their original content.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+  pageSize: integer, The maximum number of replies to return per page.
+
+Returns:
+  An object of the form:
+
+    { # A list of replies to a comment on a file.
+    "nextPageToken": "A String", # The page token for the next page of replies. This will be absent if the end of the replies list has been reached.
+    "kind": "drive#replyList", # This is always drive#replyList.
+    "replies": [ # The page of replies.
+      { # A reply to a comment on a file.
+        "kind": "drive#reply", # This is always drive#reply.
+        "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+        "author": { # Information about a Drive user. # The user who created the reply.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+        "htmlContent": "A String", # The content of the reply with HTML formatting.
+        "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+        "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+        "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+            # - resolve
+            # - reopen
+        "id": "A String", # The ID of the reply.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ update(fileId, commentId, replyId, body) +
Updates a reply with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  commentId: string, The ID of the comment. (required)
+  replyId: string, The ID of the reply. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A reply to a comment on a file.
+  "kind": "drive#reply", # This is always drive#reply.
+  "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+  "author": { # Information about a Drive user. # The user who created the reply.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+  "htmlContent": "A String", # The content of the reply with HTML formatting.
+  "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+  "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+  "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+      # - resolve
+      # - reopen
+  "id": "A String", # The ID of the reply.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # A reply to a comment on a file.
+    "kind": "drive#reply", # This is always drive#reply.
+    "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time).
+    "author": { # Information about a Drive user. # The user who created the reply.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "deleted": True or False, # Whether the reply has been deleted. A deleted reply has no content.
+    "htmlContent": "A String", # The content of the reply with HTML formatting.
+    "content": "A String", # The plain text content of the reply. This field is used for setting the content, while htmlContent should be displayed. This is required on creates if no action is specified.
+    "createdTime": "A String", # The time at which the reply was created (RFC 3339 date-time).
+    "action": "A String", # The action the reply performed to the parent comment. Valid values are:
+        # - resolve
+        # - reopen
+    "id": "A String", # The ID of the reply.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/drive_v3.revisions.html b/docs/dyn/drive_v3.revisions.html new file mode 100644 index 00000000000..798e3292b64 --- /dev/null +++ b/docs/dyn/drive_v3.revisions.html @@ -0,0 +1,254 @@ + + + +

Drive API . revisions

+

Instance Methods

+

+ delete(fileId, revisionId)

+

Permanently deletes a revision. This method is only applicable to files with binary content in Drive.

+

+ get(fileId, revisionId, acknowledgeAbuse=None)

+

Gets a revision's metadata or content by ID.

+

+ get_media(fileId, revisionId, acknowledgeAbuse=None)

+

Gets a revision's metadata or content by ID.

+

+ list(fileId)

+

Lists a file's revisions.

+

+ update(fileId, revisionId, body)

+

Updates a revision with patch semantics.

+

Method Details

+
+ delete(fileId, revisionId) +
Permanently deletes a revision. This method is only applicable to files with binary content in Drive.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  revisionId: string, The ID of the revision. (required)
+
+
+ +
+ get(fileId, revisionId, acknowledgeAbuse=None) +
Gets a revision's metadata or content by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  revisionId: string, The ID of the revision. (required)
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a revision to a file.
+    "mimeType": "A String", # The MIME type of the revision.
+    "kind": "drive#revision", # This is always drive#revision.
+    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+        # This field is only applicable to files with binary content in Drive.
+    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
+    "id": "A String", # The ID of the revision.
+    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+  }
+
+ +
+ get_media(fileId, revisionId, acknowledgeAbuse=None) +
Gets a revision's metadata or content by ID.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  revisionId: string, The ID of the revision. (required)
+  acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+
+Returns:
+  The media object as a string.
+
+    
+
+ +
+ list(fileId) +
Lists a file's revisions.
+
+Args:
+  fileId: string, The ID of the file. (required)
+
+Returns:
+  An object of the form:
+
+    { # A list of revisions of a file.
+    "kind": "drive#revisionList", # This is always drive#revisionList.
+    "revisions": [ # The full list of revisions.
+      { # The metadata for a revision to a file.
+        "mimeType": "A String", # The MIME type of the revision.
+        "kind": "drive#revision", # This is always drive#revision.
+        "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+        "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+          "me": True or False, # Whether this user is the requesting user.
+          "kind": "drive#user", # This is always drive#user.
+          "displayName": "A String", # A plain text displayable name for this user.
+          "permissionId": "A String", # The user's ID as visible in Permission resources.
+          "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+          "photoLink": "A String", # A link to the user's profile photo, if available.
+        },
+        "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+            # This field is only applicable to files with binary content in Drive.
+        "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+        "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+        "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+        "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
+        "id": "A String", # The ID of the revision.
+        "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+        "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+      },
+    ],
+  }
+
+ +
+ update(fileId, revisionId, body) +
Updates a revision with patch semantics.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  revisionId: string, The ID of the revision. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The metadata for a revision to a file.
+  "mimeType": "A String", # The MIME type of the revision.
+  "kind": "drive#revision", # This is always drive#revision.
+  "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+  "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+    "me": True or False, # Whether this user is the requesting user.
+    "kind": "drive#user", # This is always drive#user.
+    "displayName": "A String", # A plain text displayable name for this user.
+    "permissionId": "A String", # The user's ID as visible in Permission resources.
+    "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+    "photoLink": "A String", # A link to the user's profile photo, if available.
+  },
+  "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+      # This field is only applicable to files with binary content in Drive.
+  "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+  "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+  "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+  "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
+  "id": "A String", # The ID of the revision.
+  "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+  "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # The metadata for a revision to a file.
+    "mimeType": "A String", # The MIME type of the revision.
+    "kind": "drive#revision", # This is always drive#revision.
+    "modifiedTime": "A String", # The last time the revision was modified (RFC 3339 date-time).
+    "lastModifyingUser": { # Information about a Drive user. # The last user to modify this revision.
+      "me": True or False, # Whether this user is the requesting user.
+      "kind": "drive#user", # This is always drive#user.
+      "displayName": "A String", # A plain text displayable name for this user.
+      "permissionId": "A String", # The user's ID as visible in Permission resources.
+      "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+      "photoLink": "A String", # A link to the user's profile photo, if available.
+    },
+    "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
+        # This field is only applicable to files with binary content in Drive.
+    "publishAuto": True or False, # Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.
+    "originalFilename": "A String", # The original filename used to create this revision. This is only applicable to files with binary content in Drive.
+    "published": True or False, # Whether this revision is published. This is only applicable to Google Docs.
+    "size": "A String", # The size of the revision's content in bytes. This is only applicable to files with binary content in Drive.
+    "id": "A String", # The ID of the revision.
+    "md5Checksum": "A String", # The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.
+    "publishedOutsideDomain": True or False, # Whether this revision is published outside the domain. This is only applicable to Google Docs.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/gamesManagement_v1management.applications.html b/docs/dyn/gamesManagement_v1management.applications.html index c0f79d5544a..d8838c2e505 100644 --- a/docs/dyn/gamesManagement_v1management.applications.html +++ b/docs/dyn/gamesManagement_v1management.applications.html @@ -98,6 +98,7 @@

Method Details

"items": [ # The players. { # This is a JSON template for the HiddenPlayer resource. "player": { # This is a JSON template for a Player resource. # The player information. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "gamesManagement#player", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -109,6 +110,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -124,6 +126,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "kind": "gamesManagement#hiddenPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer. diff --git a/docs/dyn/games_v1.applications.html b/docs/dyn/games_v1.applications.html index d3115954b96..f0bb357b7dd 100644 --- a/docs/dyn/games_v1.applications.html +++ b/docs/dyn/games_v1.applications.html @@ -80,6 +80,9 @@

Instance Methods

played()

Indicate that the the currently authenticated user is playing your application.

+

+ verify(applicationId)

+

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Method Details

get(applicationId, language=None, platformType=None) @@ -171,4 +174,20 @@

Method Details

+
+ verify(applicationId) +
Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.
+
+Args:
+  applicationId: string, The application ID from the Google Play developer console. (required)
+
+Returns:
+  An object of the form:
+
+    { # This is a JSON template for a third party application verification response resource.
+    "player_id": "A String", # The ID of the player that was issued the auth token used in this request.
+    "kind": "games#applicationVerifyResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#applicationVerifyResponse.
+  }
+
+ \ No newline at end of file diff --git a/docs/dyn/games_v1.players.html b/docs/dyn/games_v1.players.html index 42e96755c4b..38a5681f960 100644 --- a/docs/dyn/games_v1.players.html +++ b/docs/dyn/games_v1.players.html @@ -96,6 +96,7 @@

Method Details

An object of the form: { # This is a JSON template for a Player resource. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -108,6 +109,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -126,6 +128,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. } @@ -137,8 +140,10 @@

Method Details

Args: collection: string, Collection of players being retrieved (required) Allowed values + connected - Retrieve a list of players that are also playing this game in reverse chronological order. playedWith - (DEPRECATED: please use played_with!) Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently. played_with - Retrieve a list of players you have played a multiplayer game (realtime or turn-based) with recently. + visible - Retrieve a list of players in the user's social graph that are visible to this game. pageToken: string, The token returned by the previous request. language: string, The preferred language to use for strings returned by this method. maxResults: integer, The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. @@ -150,6 +155,7 @@

Method Details

"nextPageToken": "A String", # Token corresponding to the next page of results. "items": [ # The players. { # This is a JSON template for a Player resource. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -162,6 +168,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -180,6 +187,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, ], diff --git a/docs/dyn/games_v1.rooms.html b/docs/dyn/games_v1.rooms.html index 4e9052e0d20..f0307d19627 100644 --- a/docs/dyn/games_v1.rooms.html +++ b/docs/dyn/games_v1.rooms.html @@ -200,6 +200,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -212,6 +213,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -230,6 +232,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -317,6 +320,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -329,6 +333,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -347,6 +352,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -443,6 +449,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -455,6 +462,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -473,6 +481,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -583,6 +592,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -595,6 +605,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -613,6 +624,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -794,6 +806,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -806,6 +819,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -824,6 +838,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -915,6 +930,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -927,6 +943,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -945,6 +962,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. @@ -1061,6 +1079,7 @@

Method Details

"A String", ], "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1073,6 +1092,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1091,6 +1111,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant. diff --git a/docs/dyn/games_v1.scores.html b/docs/dyn/games_v1.scores.html index 232b0cb27e7..8e230d2cc41 100644 --- a/docs/dyn/games_v1.scores.html +++ b/docs/dyn/games_v1.scores.html @@ -158,6 +158,7 @@

Method Details

], "kind": "games#playerLeaderboardScoreListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLeaderboardScoreListResponse. "player": { # This is a JSON template for a Player resource. # The Player resources for the owner of this score. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -170,6 +171,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -188,6 +190,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, } @@ -217,6 +220,7 @@

Method Details

Allowed values PUBLIC - List all scores in the public leaderboard. SOCIAL - List only social scores. + SOCIAL_1P - List only social scores, not respecting the fACL. timeSpan: string, The time span for the scores and ranks you're requesting. (required) Allowed values ALL_TIME - List the all-time top scores. @@ -245,6 +249,7 @@

Method Details

# - "DAILY" - The score is a daily high score. "formattedScore": "A String", # The localized string for the numerical value of this score. "player": { # This is a JSON template for a Player resource. # The player who holds this score. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -257,6 +262,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -275,6 +281,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. @@ -293,6 +300,7 @@

Method Details

# - "DAILY" - The score is a daily high score. "formattedScore": "A String", # The localized string for the numerical value of this score. "player": { # This is a JSON template for a Player resource. # The player who holds this score. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -305,6 +313,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -323,6 +332,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. @@ -343,6 +353,7 @@

Method Details

Allowed values PUBLIC - List all scores in the public leaderboard. SOCIAL - List only social scores. + SOCIAL_1P - List only social scores, not respecting the fACL. timeSpan: string, The time span for the scores and ranks you're requesting. (required) Allowed values ALL_TIME - List the all-time top scores. @@ -373,6 +384,7 @@

Method Details

# - "DAILY" - The score is a daily high score. "formattedScore": "A String", # The localized string for the numerical value of this score. "player": { # This is a JSON template for a Player resource. # The player who holds this score. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -385,6 +397,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -403,6 +416,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. @@ -421,6 +435,7 @@

Method Details

# - "DAILY" - The score is a daily high score. "formattedScore": "A String", # The localized string for the numerical value of this score. "player": { # This is a JSON template for a Player resource. # The player who holds this score. + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -433,6 +448,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -451,6 +467,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "formattedScoreRank": "A String", # The localized string for the rank of this score for this leaderboard. diff --git a/docs/dyn/games_v1.turnBasedMatches.html b/docs/dyn/games_v1.turnBasedMatches.html index 5fd426fcda6..e8c90907568 100644 --- a/docs/dyn/games_v1.turnBasedMatches.html +++ b/docs/dyn/games_v1.turnBasedMatches.html @@ -206,6 +206,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -218,6 +219,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -236,6 +238,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -341,6 +344,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -353,6 +357,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -371,6 +376,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -512,6 +518,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -524,6 +531,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -542,6 +550,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -648,6 +657,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -660,6 +670,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -678,6 +689,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -783,6 +795,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -795,6 +808,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -813,6 +827,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -918,6 +933,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -930,6 +946,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -948,6 +965,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1055,6 +1073,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1067,6 +1086,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1085,6 +1105,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1196,6 +1217,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1208,6 +1230,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1226,6 +1249,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1350,6 +1374,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1362,6 +1387,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1380,6 +1406,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1473,6 +1500,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1485,6 +1513,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1503,6 +1532,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1615,6 +1645,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1627,6 +1658,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1645,6 +1677,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. @@ -1796,6 +1829,7 @@

Method Details

"displayName": "A String", # The name to display for the anonymous player. }, "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) + "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. "displayName": "A String", # The name to display for the player. "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. @@ -1808,6 +1842,7 @@

Method Details

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. }, "playerId": "A String", # The ID of the player. + "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. "title": "A String", # The player's title rewarded for their game activities. "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. @@ -1826,6 +1861,7 @@

Method Details

"level": 42, # The level for the user. }, }, + "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. "avatarImageUrl": "A String", # The base URL for the image that represents the player. }, "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. diff --git a/docs/dyn/genomics_v1.callsets.html b/docs/dyn/genomics_v1.callsets.html index eb358d5afb0..01de614573b 100644 --- a/docs/dyn/genomics_v1.callsets.html +++ b/docs/dyn/genomics_v1.callsets.html @@ -76,29 +76,29 @@

Genomics API . create(body, x__xgafv=None)

-

Creates a new call set.

+

Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(callSetId, x__xgafv=None)

-

Deletes a call set.

+

Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(callSetId, x__xgafv=None)

-

Gets a call set by ID.

+

Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

patch(callSetId, body, updateMask=None, x__xgafv=None)

-

Updates a call set. This method supports patch semantics.

+

Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

search(body, x__xgafv=None)

-

Gets a list of call sets matching the criteria. Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).

+

Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).

Method Details

create(body, x__xgafv=None) -
Creates a new call set.
+  
Creates a new call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
+{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
     "a_key": [
       "",
@@ -118,7 +118,7 @@ 

Method Details

Returns: An object of the form: - { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. + { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -136,7 +136,7 @@

Method Details

delete(callSetId, x__xgafv=None) -
Deletes a call set.
+  
Deletes a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   callSetId: string, The ID of the call set to be deleted. (required)
@@ -151,7 +151,7 @@ 

Method Details

get(callSetId, x__xgafv=None) -
Gets a call set by ID.
+  
Gets a call set by ID. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   callSetId: string, The ID of the call set. (required)
@@ -160,7 +160,7 @@ 

Method Details

Returns: An object of the form: - { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. + { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -178,14 +178,14 @@

Method Details

patch(callSetId, body, updateMask=None, x__xgafv=None) -
Updates a call set. This method supports patch semantics.
+  
Updates a call set. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.
 
 Args:
   callSetId: string, The ID of the call set to be updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set.
+{ # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values).
     "a_key": [
       "",
@@ -200,13 +200,13 @@ 

Method Details

"id": "A String", # The server-generated call set ID, unique across all call sets. } - updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is [name][google.genomics.v1.CallSet.name]. The only acceptable value is "name". If unspecified, all mutable fields will be updated. + updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated. x__xgafv: string, V1 error format. Returns: An object of the form: - { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. + { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -224,7 +224,7 @@

Method Details

search(body, x__xgafv=None) -
Gets a list of call sets matching the criteria. Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).
+  
Gets a list of call sets matching the criteria. For the definitions of call sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).
 
 Args:
   body: object, The request body. (required)
@@ -236,7 +236,7 @@ 

Method Details

"A String", ], "name": "A String", # Only return call sets for which a substring of the name matches this string. - "pageSize": 42, # The maximum number of call sets to return. If unspecified, defaults to 1000. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. } x__xgafv: string, V1 error format. @@ -247,7 +247,7 @@

Method Details

{ # The call set search response. "nextPageToken": "A String", # 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. "callSets": [ # The list of matching call sets. - { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. + { # A call set is a collection of variant calls, typically for one sample. It belongs to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional call set information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", diff --git a/docs/dyn/genomics_v1.datasets.html b/docs/dyn/genomics_v1.datasets.html index 14ca86cfa0b..baabdffcdc0 100644 --- a/docs/dyn/genomics_v1.datasets.html +++ b/docs/dyn/genomics_v1.datasets.html @@ -76,44 +76,44 @@

Genomics API . create(body, x__xgafv=None)

-

Creates a new dataset.

+

Creates a new dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(datasetId, x__xgafv=None)

-

Deletes a dataset.

+

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)

get(datasetId, x__xgafv=None)

-

Gets a dataset by ID.

+

Gets a dataset by ID. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

getIamPolicy(resource, body, x__xgafv=None)

-

+

Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See Getting a Policy for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None)

-

Lists datasets within a project.

+

Lists datasets within a project. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(datasetId, body, updateMask=None, x__xgafv=None)

-

Updates a dataset. This method supports patch semantics.

+

Updates 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) This method supports patch semantics.

setIamPolicy(resource, body, x__xgafv=None)

-

+

Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) See Setting a Policy for more information.

testIamPermissions(resource, body, x__xgafv=None)

-

+

Returns permissions that a caller has on the specified resource. See Testing Permissions for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

undelete(datasetId, body, x__xgafv=None)

-

Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.

+

Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This operation is only possible for a week after the deletion occurred.

Method Details

create(body, x__xgafv=None) -
Creates a new dataset.
+  
Creates a new dataset. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A Dataset is a collection of genomic data.
+{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
   "id": "A String", # The server-generated dataset ID, unique across all datasets.
   "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
@@ -125,7 +125,7 @@ 

Method Details

Returns: An object of the form: - { # A Dataset is a collection of genomic data. + { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. "id": "A String", # The server-generated dataset ID, unique across all datasets. "createTime": "A String", # The time this dataset was created, in seconds from the epoch. @@ -135,7 +135,7 @@

Method Details

delete(datasetId, x__xgafv=None) -
Deletes a dataset.
+  
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)
 
 Args:
   datasetId: string, The ID of the dataset to be deleted. (required)
@@ -150,7 +150,7 @@ 

Method Details

get(datasetId, x__xgafv=None) -
Gets a dataset by ID.
+  
Gets a dataset by ID. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   datasetId: string, The ID of the dataset. (required)
@@ -159,7 +159,7 @@ 

Method Details

Returns: An object of the form: - { # A Dataset is a collection of genomic data. + { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. "id": "A String", # The server-generated dataset ID, unique across all datasets. "createTime": "A String", # The time this dataset was created, in seconds from the epoch. @@ -169,7 +169,7 @@

Method Details

getIamPolicy(resource, body, x__xgafv=None) -
+  
Gets the access control policy for the dataset. This is empty if the policy or resource does not exist. See Getting a Policy for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
@@ -184,26 +184,26 @@ 

Method Details

Returns: An object of the form: - { # 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). + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
list(pageSize=None, projectId=None, pageToken=None, x__xgafv=None) -
Lists datasets within a project.
+  
Lists datasets within a project. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
-  pageSize: integer, The maximum number of results returned by this request. If unspecified, defaults to 50. The maximum value is 1024.
+  pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024.
   projectId: string, Required. The project to list datasets for.
   pageToken: string, 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.
   x__xgafv: string, V1 error format.
@@ -214,7 +214,7 @@ 

Method Details

{ # The dataset list response. "nextPageToken": "A String", # 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. "datasets": [ # The list of matching Datasets. - { # A Dataset is a collection of genomic data. + { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. "id": "A String", # The server-generated dataset ID, unique across all datasets. "createTime": "A String", # The time this dataset was created, in seconds from the epoch. @@ -240,27 +240,27 @@

Method Details

patch(datasetId, body, updateMask=None, x__xgafv=None) -
Updates a dataset. This method supports patch semantics.
+  
Updates 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) This method supports patch semantics.
 
 Args:
   datasetId: string, The ID of the dataset to be updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A Dataset is a collection of genomic data.
+{ # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
   "id": "A String", # The server-generated dataset ID, unique across all datasets.
   "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
   "name": "A String", # The dataset name.
 }
 
-  updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is [name][google.genomics.v1.Dataset.name]. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
+  updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is name. The only acceptable value is "name". If unspecified, all mutable fields will be updated.
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # A Dataset is a collection of genomic data.
+    { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
     "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to.
     "id": "A String", # The server-generated dataset ID, unique across all datasets.
     "createTime": "A String", # The time this dataset was created, in seconds from the epoch.
@@ -270,7 +270,7 @@ 

Method Details

setIamPolicy(resource, body, x__xgafv=None) -
+  
Sets the access control policy on the specified dataset. Replaces any existing policy. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) See Setting a Policy for more information.
 
 Args:
   resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
@@ -278,17 +278,17 @@ 

Method Details

The object takes the form of: { # Request message for `SetIamPolicy` method. - "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. + "policy": { # 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). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }, } @@ -297,23 +297,23 @@

Method Details

Returns: An object of the form: - { # 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). + { # 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). "bindings": [ # 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. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required - "members": [ # 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`. + "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. - "etag": "A String", # Can be used to perform a read-modify-write. + "etag": "A String", # `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. }
testIamPermissions(resource, body, x__xgafv=None) -
+  
Returns permissions that a caller has on the specified resource. See Testing Permissions for more information. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   resource: string, REQUIRED: The resource for which policy is being specified. Format is `datasets/`. (required)
@@ -340,7 +340,7 @@ 

Method Details

undelete(datasetId, body, x__xgafv=None) -
Undeletes a dataset by restoring a dataset which was deleted via this API. This operation is only possible for a week after the deletion occurred.
+  
Undeletes a dataset by restoring a dataset which was deleted via this API. For the definitions of datasets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This operation is only possible for a week after the deletion occurred.
 
 Args:
   datasetId: string, The ID of the dataset to be undeleted. (required)
@@ -355,7 +355,7 @@ 

Method Details

Returns: An object of the form: - { # A Dataset is a collection of genomic data. + { # A Dataset is a collection of genomic data. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "projectId": "A String", # The Google Developers Console project ID that this dataset belongs to. "id": "A String", # The server-generated dataset ID, unique across all datasets. "createTime": "A String", # The time this dataset was created, in seconds from the epoch. diff --git a/docs/dyn/genomics_v1.operations.html b/docs/dyn/genomics_v1.operations.html index 9ca849e2231..57eff73e1f1 100644 --- a/docs/dyn/genomics_v1.operations.html +++ b/docs/dyn/genomics_v1.operations.html @@ -76,10 +76,7 @@

Genomics API . cancel(name, body, x__xgafv=None)

-

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or [Operations.ListOperations][google.longrunning.Operations.ListOperations] to check whether the cancellation succeeded or the operation completed despite cancellation.

-

- delete(name, x__xgafv=None)

-

This method is not implemented. To cancel an operation, please use [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.

get(name, x__xgafv=None)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@@ -92,14 +89,14 @@

Instance Methods

Method Details

cancel(name, body, x__xgafv=None) -
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or [Operations.ListOperations][google.longrunning.Operations.ListOperations] to check whether the cancellation succeeded or the operation completed despite cancellation.
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.
 
 Args:
   name: string, The name of the operation resource to be cancelled. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
+{ # The request message for Operations.CancelOperation.
   }
 
   x__xgafv: string, V1 error format.
@@ -111,21 +108,6 @@ 

Method Details

}
-
- delete(name, x__xgafv=None) -
This method is not implemented. To cancel an operation, please use [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
-
-Args:
-  name: string, The name of the operation resource to be deleted. (required)
-  x__xgafv: string, V1 error format.
-
-Returns:
-  An object of the form:
-
-    { # 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 `{}`.
-  }
-
-
get(name, x__xgafv=None)
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
@@ -138,12 +120,12 @@ 

Method Details

An object of the form: { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -152,7 +134,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }
@@ -165,22 +147,22 @@

Method Details

Args: name: string, The name of the operation collection. (required) pageSize: integer, The maximum number of results to return. If unspecified, defaults to 256. The maximum value is 2048. - filter: string, A string for filtering [Operations][google.longrunning.Operation]. The following filter fields are supported: * projectId: Required. Corresponds to [OperationMetadata.projectId][google.genomics.v1.OperationMetadata.project_id]. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` + filter: string, A string for filtering Operations. The following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` pageToken: string, The standard list page token. x__xgafv: string, V1 error format. Returns: An object of the form: - { # The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations]. + { # The response message for Operations.ListOperations. "operations": [ # A list of operations that matches the specified filter in the request. { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -189,7 +171,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }, diff --git a/docs/dyn/genomics_v1.readgroupsets.coveragebuckets.html b/docs/dyn/genomics_v1.readgroupsets.coveragebuckets.html index 90234f6e716..5926a5b6605 100644 --- a/docs/dyn/genomics_v1.readgroupsets.coveragebuckets.html +++ b/docs/dyn/genomics_v1.readgroupsets.coveragebuckets.html @@ -76,14 +76,14 @@

Genomics API . list(readGroupSetId, targetBucketWidth=None, pageSize=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None)

-

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

+

Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(readGroupSetId, targetBucketWidth=None, pageSize=None, x__xgafv=None, end=None, start=None, referenceName=None, pageToken=None) -
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.
+  
Lists fixed width coverage buckets for a read group set, each of which correspond to a range of a reference sequence. Each bucket summarizes coverage information across its corresponding genomic range. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Coverage is defined as the number of reads which are aligned to a given base in the reference sequence. Coverage buckets are available at several precomputed bucket widths, enabling retrieval of various coverage 'zoom levels'. The caller must have READ permissions for the target read group set.
 
 Args:
   readGroupSetId: string, Required. The ID of the read group set over which coverage is requested. (required)
diff --git a/docs/dyn/genomics_v1.readgroupsets.html b/docs/dyn/genomics_v1.readgroupsets.html
index 80782eab482..1da4960e6ca 100644
--- a/docs/dyn/genomics_v1.readgroupsets.html
+++ b/docs/dyn/genomics_v1.readgroupsets.html
@@ -81,26 +81,26 @@ 

Instance Methods

delete(readGroupSetId, x__xgafv=None)

-

Deletes a read group set.

+

Deletes a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

export(readGroupSetId, body, x__xgafv=None)

-

Exports a read group set to a BAM file in Google Cloud Storage. Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See [ImportReadGroupSets](google.genomics.v1.ReadServiceV1.ImportReadGroupSets) for caveats.

+

Exports a read group set to a BAM file in Google Cloud Storage. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See [ImportReadGroupSets](google.genomics.v1.ReadServiceV1.ImportReadGroupSets) for caveats.

get(readGroupSetId, x__xgafv=None)

-

Gets a read group set by ID.

+

Gets a read group set by ID. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

import_(body, x__xgafv=None)

-

Creates read group sets by asynchronously importing the provided information. The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (and "BQ" tag, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)

+

Creates read group sets by asynchronously importing the provided information. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)

patch(readGroupSetId, body, updateMask=None, x__xgafv=None)

-

Updates a read group set. This method supports patch semantics.

+

Updates a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.

search(body, x__xgafv=None)

-

Searches for read group sets matching the criteria. Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).

+

Searches for read group sets matching the criteria. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).

Method Details

delete(readGroupSetId, x__xgafv=None) -
Deletes a read group set.
+  
Deletes a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   readGroupSetId: string, The ID of the read group set to be deleted. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
@@ -115,15 +115,15 @@ 

Method Details

export(readGroupSetId, body, x__xgafv=None) -
Exports a read group set to a BAM file in Google Cloud Storage. Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See [ImportReadGroupSets](google.genomics.v1.ReadServiceV1.ImportReadGroupSets) for caveats.
+  
Exports a read group set to a BAM file in Google Cloud Storage. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Note that currently there may be some differences between exported BAM files and the original BAM file at the time of import. See [ImportReadGroupSets](google.genomics.v1.ReadServiceV1.ImportReadGroupSets) for caveats.
 
 Args:
-  readGroupSetId: string, Required. The ID of the read group set to export. (required)
+  readGroupSetId: string, Required. The ID of the read group set to export. The caller must have READ access to this read group set. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # The read group set export request.
-    "projectId": "A String", # Required. The Google Developers Console project ID that owns this export.
+    "projectId": "A String", # Required. The Google Developers Console project ID that owns this export. The caller must have WRITE access to this project.
     "referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use `*` to export only unmapped reads.
       "A String",
     ],
@@ -136,12 +136,12 @@ 

Method Details

An object of the form: { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -150,7 +150,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }
@@ -158,7 +158,7 @@

Method Details

get(readGroupSetId, x__xgafv=None) -
Gets a read group set by ID.
+  
Gets a read group set by ID. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   readGroupSetId: string, The ID of the read group set. (required)
@@ -167,7 +167,7 @@ 

Method Details

Returns: An object of the form: - { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. + { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional read group set information. "a_key": [ "", @@ -189,32 +189,32 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], - "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. + "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group. "experiment": { # The experiment used to generate this read group. "sequencingCenter": "A String", # The sequencing center used as part of this experiment. - "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system. - "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. - "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. + "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation. + "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec. + "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. - "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the `@RG ID` field in the SAM spec. For that value, see the `name` field. - "datasetId": "A String", # The ID of the dataset this read group belongs to. + "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. + "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name. + "datasetId": "A String", # The dataset to which this read group belongs. "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec. }, ], "filename": "A String", # The filename of the original source file for this read group set, if any. - "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to. + "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned. "id": "A String", # The server-generated read group set ID, unique for all read group sets. - "datasetId": "A String", # The dataset ID. + "datasetId": "A String", # The dataset to which this read group set belongs. }
import_(body, x__xgafv=None) -
Creates read group sets by asynchronously importing the provided information. The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (and "BQ" tag, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)
+  
Creates read group sets by asynchronously importing the provided information. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) The caller must have WRITE permissions to the dataset. ## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import - Tags will be converted to strings - tag types are not preserved - Comments (`@CO`) in the input file header will not be preserved - Original header order of references (`@SQ`) will not be preserved - Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (reference name and position)
 
 Args:
   body: object, The request body. (required)
@@ -235,12 +235,12 @@ 

Method Details

An object of the form: { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -249,7 +249,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }
@@ -257,14 +257,14 @@

Method Details

patch(readGroupSetId, body, updateMask=None, x__xgafv=None) -
Updates a read group set. This method supports patch semantics.
+  
Updates a read group set. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics.
 
 Args:
   readGroupSetId: string, The ID of the read group set to be updated. The caller must have WRITE permissions to the dataset associated with this read group set. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group.
+{ # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "info": { # A map of additional read group set information.
     "a_key": [
       "",
@@ -286,35 +286,35 @@ 

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], - "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. + "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group. "experiment": { # The experiment used to generate this read group. "sequencingCenter": "A String", # The sequencing center used as part of this experiment. - "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system. - "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. - "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. + "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation. + "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec. + "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. - "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the `@RG ID` field in the SAM spec. For that value, see the `name` field. - "datasetId": "A String", # The ID of the dataset this read group belongs to. + "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. + "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name. + "datasetId": "A String", # The dataset to which this read group belongs. "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec. }, ], "filename": "A String", # The filename of the original source file for this read group set, if any. - "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to. + "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned. "id": "A String", # The server-generated read group set ID, unique for all read group sets. - "datasetId": "A String", # The dataset ID. + "datasetId": "A String", # The dataset to which this read group set belongs. } - updateMask: string, An optional mask specifying which fields to update. At this time, mutable fields are [referenceSetId][google.genomics.v1.ReadGroupSet.reference_set_id] and [name][google.genomics.v1.ReadGroupSet.name]. Acceptable values are "referenceSetId" and "name". If unspecified, all mutable fields will be updated. + updateMask: string, An optional mask specifying which fields to update. Supported fields: * name. * referenceSetId. Leaving `updateMask` unset is equivalent to specifying all mutable fields. x__xgafv: string, V1 error format. Returns: An object of the form: - { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. + { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional read group set information. "a_key": [ "", @@ -336,32 +336,32 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], - "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. + "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group. "experiment": { # The experiment used to generate this read group. "sequencingCenter": "A String", # The sequencing center used as part of this experiment. - "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system. - "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. - "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. + "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation. + "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec. + "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. - "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the `@RG ID` field in the SAM spec. For that value, see the `name` field. - "datasetId": "A String", # The ID of the dataset this read group belongs to. + "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. + "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name. + "datasetId": "A String", # The dataset to which this read group belongs. "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec. }, ], "filename": "A String", # The filename of the original source file for this read group set, if any. - "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to. + "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned. "id": "A String", # The server-generated read group set ID, unique for all read group sets. - "datasetId": "A String", # The dataset ID. + "datasetId": "A String", # The dataset to which this read group set belongs. }
search(body, x__xgafv=None) -
Searches for read group sets matching the criteria. Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).
+  
Searches for read group sets matching the criteria. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).
 
 Args:
   body: object, The request body. (required)
@@ -373,7 +373,7 @@ 

Method Details

"A String", ], "name": "A String", # Only return read group sets for which a substring of the name matches this string. - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 1024. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024. } x__xgafv: string, V1 error format. @@ -384,7 +384,7 @@

Method Details

{ # The read group set search response. "nextPageToken": "A String", # 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. "readGroupSets": [ # The list of matching read group sets. - { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. + { # A read group set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way. * A read group set belongs to one dataset. * A read group belongs to one read group set. * A read belongs to one read group. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "info": { # A map of additional read group set information. "a_key": [ "", @@ -406,26 +406,26 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with `prevProgramId` to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], - "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. + "sampleId": "A String", # A client-supplied sample identifier for the reads in this read group. "experiment": { # The experiment used to generate this read group. "sequencingCenter": "A String", # The sequencing center used as part of this experiment. - "libraryId": "A String", # The library used as part of this experiment. Note: This is not an actual ID within this repository, but rather an identifier for a library which may be meaningful to some external system. - "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. - "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. + "libraryId": "A String", # A client-supplied library identifier; a library is a collection of DNA fragments which have been prepared for sequencing from a sample. This field is important for quality control as error or bias can be introduced during sample preparation. + "instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in the SAM spec. + "platformUnit": "A String", # The platform unit used as part of this experiment, for example flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the @RG PU field in the SAM spec. }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. - "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the `@RG ID` field in the SAM spec. For that value, see the `name` field. - "datasetId": "A String", # The ID of the dataset this read group belongs to. + "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. + "id": "A String", # The server-generated read group ID, unique for all read groups. Note: This is different than the @RG ID field in the SAM spec. For that value, see name. + "datasetId": "A String", # The dataset to which this read group belongs. "name": "A String", # The read group name. This corresponds to the @RG ID field in the SAM spec. }, ], "filename": "A String", # The filename of the original source file for this read group set, if any. - "referenceSetId": "A String", # The reference set the reads in this read group set are aligned to. + "referenceSetId": "A String", # The reference set to which the reads in this read group set are aligned. "id": "A String", # The server-generated read group set ID, unique for all read group sets. - "datasetId": "A String", # The dataset ID. + "datasetId": "A String", # The dataset to which this read group set belongs. }, ], }
diff --git a/docs/dyn/genomics_v1.reads.html b/docs/dyn/genomics_v1.reads.html index a785ae07387..d50ce67c017 100644 --- a/docs/dyn/genomics_v1.reads.html +++ b/docs/dyn/genomics_v1.reads.html @@ -76,11 +76,14 @@

Genomics API . search(body, x__xgafv=None)

-

Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).

+

Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads 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 reads in the same order across their respective streams of paginated responses. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).

+

+ stream(body, x__xgafv=None)

+

Returns a stream of all the reads matching the search request, ordered by reference name, position, and ID.

Method Details

search(body, x__xgafv=None) -
Gets a list of reads for one or more read group sets. Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).
+  
Gets a list of reads for one or more read group sets. For the definitions of read group sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Reads search operates over a genomic coordinate space of reference sequence & position defined over the reference sequences to which the requested read group sets are aligned. If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads 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 reads in the same order across their respective streams of paginated responses. Implements [GlobalAllianceApi.searchReads](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L85).
 
 Args:
   body: object, The request body. (required)
@@ -91,10 +94,10 @@ 

Method Details

"readGroupIds": [ # The IDs of the read groups within which to search for reads. All specified read groups must belong to the same read group sets. Must specify one of `readGroupSetIds` or `readGroupIds`. "A String", ], - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048. "pageToken": "A String", # 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. "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified. - "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped reads are returned. + "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, only unmapped reads are returned. If unspecified, all reads (mapped and unmapped) are returned. "readGroupSetIds": [ # The IDs of the read groups sets within which to search for reads. All specified read group sets must be aligned against a common set of reference sequences; this defines the genomic coordinates for the query. Must specify one of `readGroupSetIds` or `readGroupIds`. "A String", ], @@ -108,33 +111,103 @@

Method Details

{ # The read search response. "nextPageToken": "A String", # 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. "alignments": [ # The list of matching alignments sorted by mapped genomic coordinate, if any, ascending in position within the same reference. Unmapped reads, which have no position, are returned contiguously and are sorted in ascending lexicographic order by fragment name. - { # A read alignment describes a linear alignment of a string of DNA to a [reference sequence][google.genomics.v1.Reference], in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one [read group set][google.genomics.v1.ReadGroupSet]. ### Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this: out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out ### Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the `cigar` field. Note that this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr + { # A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads (reads having a non-null `alignment`) can be aligned to either the forward or the reverse strand of their associated reference. Strandedness of a mapped read is encoded by `alignment.position.reverseStrand`. If we consider the reference to be a forward-stranded coordinate space of `[0, reference.length)` with `0` as the left-most position and `reference.length` as the right-most position, reads are always aligned left to right. That is, `alignment.position.position` always refers to the left-most reference coordinate and `alignment.cigar` describes the alignment of this read to the reference from left to right. All per-base fields such as `alignedSequence` and `alignedQuality` share this same left-to-right orientation; this is true of reads which are aligned to either strand. For reverse-stranded reads, this means that `alignedSequence` is the reverse complement of the bases that were originally reported by the sequencing machine. ### Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this: out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out ### Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the `cigar` field. Note that this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr + "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values). + "a_key": [ + "", + ], + }, + "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400). + "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The mapping of the primary alignment of the `(readNumber+1)%numberReads` read in the fragment. It replaces mate position and mate strand in SAM. + "position": "A String", # The 0-based offset from the start of the forward strand for that reference. + "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand. + "referenceName": "A String", # The name of the reference in whatever reference set is being used. + }, + "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set. + "numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1). + "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200). + "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM. + "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80. + "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2). + "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID which is distinct from SAM's RG tag (for that value, see ReadGroup.name). + "supplementaryAlignment": True or False, # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. Supplementary alignments are used in the representation of a chimeric alignment. In a chimeric alignment, a read is split into multiple linear alignments that map to different reference contigs. The first linear alignment in the read will be designated as the representative alignment; the remaining linear alignments will be designated as supplementary alignments. These alignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The `alignedSequence` and `alignedQuality` fields in the alignment record will only represent the bases for its respective linear alignment. + "alignedQuality": [ # The quality of the read sequence contained in this alignment record (equivalent to QUAL in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. + 42, + ], + "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM. + "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, **without CIGAR operations applied** (equivalent to SEQ in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. + "id": "A String", # The server-generated read ID, unique across all reads. This is different from the `fragmentName`. + "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads. + "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment. + "position": "A String", # The 0-based offset from the start of the forward strand for that reference. + "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand. + "referenceName": "A String", # The name of the reference in whatever reference set is being used. + }, + "cigar": [ # Represents the local alignment of this sequence (alignment matches, indels, etc) against the reference. + { # A single CIGAR operation. + "referenceSequence": "A String", # `referenceSequence` is only used at mismatches (`SEQUENCE_MISMATCH`) and deletions (`DELETE`). Filling this field replaces SAM's MD tag. If the relevant information is not available, this field is unset. + "operation": "A String", + "operationLength": "A String", # The number of genomic bases that the operation runs for. Required. + }, + ], + "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer. + }, + "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both `secondaryAlignment` and `supplementaryAlignment` are false. + }, + ], + }
+
+ +
+ stream(body, x__xgafv=None) +
Returns a stream of all the reads matching the search request, ordered by reference name, position, and ID.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The stream reads request.
+    "projectId": "A String", # The Google Developers Console project ID or number which will be billed for this access. The caller must have WRITE access to this project. Required.
+    "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, `referenceName` must also be specified.
+    "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, `referenceName` must also be specified.
+    "readGroupSetId": "A String", # The ID of the read group set from which to stream reads.
+    "referenceName": "A String", # The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped reads are returned.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    {
+    "alignments": [
+      { # A read alignment describes a linear alignment of a string of DNA to a reference sequence, in addition to metadata about the fragment (the molecule of DNA sequenced) and the read (the bases which were read by the sequencer). A read is equivalent to a line in a SAM file. A read belongs to exactly one read group and exactly one read group set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) ### Reverse-stranded reads Mapped reads (reads having a non-null `alignment`) can be aligned to either the forward or the reverse strand of their associated reference. Strandedness of a mapped read is encoded by `alignment.position.reverseStrand`. If we consider the reference to be a forward-stranded coordinate space of `[0, reference.length)` with `0` as the left-most position and `reference.length` as the right-most position, reads are always aligned left to right. That is, `alignment.position.position` always refers to the left-most reference coordinate and `alignment.cigar` describes the alignment of this read to the reference from left to right. All per-base fields such as `alignedSequence` and `alignedQuality` share this same left-to-right orientation; this is true of reads which are aligned to either strand. For reverse-stranded reads, this means that `alignedSequence` is the reverse complement of the bases that were originally reported by the sequencing machine. ### Generating a reference-aligned sequence string When interacting with mapped reads, it's often useful to produce a string representing the local alignment of the read to reference. The following pseudocode demonstrates one way of doing this: out = "" offset = 0 for c in read.alignment.cigar { switch c.operation { case "ALIGNMENT_MATCH", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH": out += read.alignedSequence[offset:offset+c.operationLength] offset += c.operationLength break case "CLIP_SOFT", "INSERT": offset += c.operationLength break case "PAD": out += repeat("*", c.operationLength) break case "DELETE": out += repeat("-", c.operationLength) break case "SKIP": out += repeat(" ", c.operationLength) break case "CLIP_HARD": break } } return out ### Converting to SAM's CIGAR string The following pseudocode generates a SAM CIGAR string from the `cigar` field. Note that this is a lossy conversion (`cigar.referenceSequence` is lost). cigarMap = { "ALIGNMENT_MATCH": "M", "INSERT": "I", "DELETE": "D", "SKIP": "N", "CLIP_SOFT": "S", "CLIP_HARD": "H", "PAD": "P", "SEQUENCE_MATCH": "=", "SEQUENCE_MISMATCH": "X", } cigarStr = "" for c in read.alignment.cigar { cigarStr += c.operationLength + cigarMap[c.operation] } return cigarStr
         "info": { # A map of additional read alignment information. This must be of the form map (string key mapping to a list of string values).
           "a_key": [
             "",
           ],
         },
-        "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400)
+        "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400).
         "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The mapping of the primary alignment of the `(readNumber+1)%numberReads` read in the fragment. It replaces mate position and mate strand in SAM.
           "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
           "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
           "referenceName": "A String", # The name of the reference in whatever reference set is being used.
         },
-        "readGroupSetId": "A String", # The ID of the read group set this read belongs to. (Every read must belong to exactly one read group set.)
+        "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set.
         "numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1).
-        "failedVendorQualityChecks": True or False, # SAM flag 0x200
+        "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200).
         "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM.
         "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80.
-        "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2)
-        "readGroupId": "A String", # The ID of the read group this read belongs to. (Every read must belong to exactly one read group.)
+        "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2).
+        "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID which is distinct from SAM's RG tag (for that value, see ReadGroup.name).
         "supplementaryAlignment": True or False, # Whether this alignment is supplementary. Equivalent to SAM flag 0x800. Supplementary alignments are used in the representation of a chimeric alignment. In a chimeric alignment, a read is split into multiple linear alignments that map to different reference contigs. The first linear alignment in the read will be designated as the representative alignment; the remaining linear alignments will be designated as supplementary alignments. These alignments may have different mapping quality scores. In each linear alignment in a chimeric alignment, the read will be hard clipped. The `alignedSequence` and `alignedQuality` fields in the alignment record will only represent the bases for its respective linear alignment.
-        "alignedQuality": [ # The quality of the read sequence contained in this alignment record. `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
+        "alignedQuality": [ # The quality of the read sequence contained in this alignment record (equivalent to QUAL in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
           42,
         ],
         "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM.
-        "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, *without CIGAR operations applied*. `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
+        "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, **without CIGAR operations applied** (equivalent to SEQ in SAM). `alignedSequence` and `alignedQuality` may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence.
         "id": "A String", # The server-generated read ID, unique across all reads. This is different from the `fragmentName`.
-        "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field will be null if the read is unmapped.
+        "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads.
           "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment.
             "position": "A String", # The 0-based offset from the start of the forward strand for that reference.
             "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand.
@@ -147,7 +220,7 @@ 

Method Details

"operationLength": "A String", # The number of genomic bases that the operation runs for. Required. }, ], - "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. + "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer. }, "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both `secondaryAlignment` and `supplementaryAlignment` are false. }, diff --git a/docs/dyn/genomics_v1.references.bases.html b/docs/dyn/genomics_v1.references.bases.html index 3c589050dff..4e5e2068502 100644 --- a/docs/dyn/genomics_v1.references.bases.html +++ b/docs/dyn/genomics_v1.references.bases.html @@ -76,19 +76,19 @@

Genomics API . list(referenceId, end=None, pageSize=None, x__xgafv=None, pageToken=None, start=None)

-

Lists the bases in a reference, optionally restricted to a range. Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).

+

Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(referenceId, end=None, pageSize=None, x__xgafv=None, pageToken=None, start=None) -
Lists the bases in a reference, optionally restricted to a range. Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).
+  
Lists the bases in a reference, optionally restricted to a range. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).
 
 Args:
   referenceId: string, The ID of the reference. (required)
   end: string, The end position (0-based, exclusive) of this query. Defaults to the length of this reference.
-  pageSize: integer, Specifies the maximum number of bases to return in a single page.
+  pageSize: integer, The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs).
   x__xgafv: string, V1 error format.
   pageToken: string, 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.
   start: string, The start position (0-based) of this query. Defaults to 0.
diff --git a/docs/dyn/genomics_v1.references.html b/docs/dyn/genomics_v1.references.html
index bd0ac736a66..eb91ff86859 100644
--- a/docs/dyn/genomics_v1.references.html
+++ b/docs/dyn/genomics_v1.references.html
@@ -81,14 +81,14 @@ 

Instance Methods

get(referenceId, x__xgafv=None)

-

Gets a reference. Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

+

Gets a reference. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).

search(body, x__xgafv=None)

-

Searches for references which match the given criteria. Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

+

Searches for references which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).

Method Details

get(referenceId, x__xgafv=None) -
Gets a reference. Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).
+  
Gets a reference. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).
 
 Args:
   referenceId: string, The ID of the reference. (required)
@@ -97,14 +97,14 @@ 

Method Details

Returns: An object of the form: - { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. + { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "name": "A String", # The name of this reference, for example `22`. - "sourceUri": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair. + "sourceUri": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file. "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`. "A String", ], "length": "A String", # The length of this reference's sequence. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. "id": "A String", # The server-generated reference ID, unique across all references. "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format. }
@@ -112,22 +112,22 @@

Method Details

search(body, x__xgafv=None) -
Searches for references which match the given criteria. Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).
+  
Searches for references which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "md5checksums": [ # If present, return references for which the `md5checksum` matches. See `Reference.md5checksum` for construction details.
+    "md5checksums": [ # If present, return references for which the md5checksum matches exactly.
       "A String",
     ],
     "pageToken": "A String", # 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.
     "referenceSetId": "A String", # If present, return only references which belong to this reference set.
-    "accessions": [ # If present, return references for which the accession matches this string. Best to give a version number, for example `GCF_000001405.26`. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
+    "accessions": [ # If present, return references for which a prefix of any of sourceAccessions match any of these strings. Accession numbers typically have a main number and a version, for example `GCF_000001405.26`.
       "A String",
     ],
-    "pageSize": 42, # Specifies the maximum number of results to return in a single page.
+    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
   }
 
   x__xgafv: string, V1 error format.
@@ -138,14 +138,14 @@ 

Method Details

{ "nextPageToken": "A String", # 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. "references": [ # The matching references. - { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. + { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "name": "A String", # The name of this reference, for example `22`. - "sourceUri": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair. + "sourceUri": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file. "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example `GCF_000001405.26`. "A String", ], "length": "A String", # The length of this reference's sequence. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. "id": "A String", # The server-generated reference ID, unique across all references. "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format. }, diff --git a/docs/dyn/genomics_v1.referencesets.html b/docs/dyn/genomics_v1.referencesets.html index 7bcbcc2b01f..c418ddc2396 100644 --- a/docs/dyn/genomics_v1.referencesets.html +++ b/docs/dyn/genomics_v1.referencesets.html @@ -76,14 +76,14 @@

Genomics API . get(referenceSetId, x__xgafv=None)

-

Gets a reference set. Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

+

Gets a reference set. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

search(body, x__xgafv=None)

-

Searches for reference sets which match the given criteria. Implements [GlobalAllianceApi.searchReferenceSets](http://ga4gh.org/documentation/api/v0.5.1/ga4gh_api.html#/schema/org.ga4gh.searchReferenceSets).

+

Searches for reference sets which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)

Method Details

get(referenceSetId, x__xgafv=None) -
Gets a reference set. Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).
+  
Gets a reference set. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).
 
 Args:
   referenceSetId: string, The ID of the reference set. (required)
@@ -92,7 +92,7 @@ 

Method Details

Returns: An object of the form: - { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. + { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "description": "A String", # Free text description of this reference set. "sourceUri": "A String", # The URI from which the references were obtained. "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set. @@ -104,27 +104,27 @@

Method Details

], "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format. "id": "A String", # The server-generated reference set ID, unique across all reference sets. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome. }
search(body, x__xgafv=None) -
Searches for reference sets which match the given criteria. Implements [GlobalAllianceApi.searchReferenceSets](http://ga4gh.org/documentation/api/v0.5.1/ga4gh_api.html#/schema/org.ga4gh.searchReferenceSets).
+  
Searches for reference sets which match the given criteria. For the definitions of references and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
 {
-    "md5checksums": [ # If present, return references for which the `md5checksum` matches. See `ReferenceSet.md5checksum` for details.
+    "md5checksums": [ # If present, return reference sets for which the md5checksum matches exactly.
       "A String",
     ],
     "assemblyId": "A String", # If present, return reference sets for which a substring of their `assemblyId` matches this string (case insensitive).
-    "accessions": [ # If present, return references for which the accession matches any of these strings. Best to give a version number, for example `GCF_000001405.26`. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences.
+    "accessions": [ # If present, return reference sets for which a prefix of any of sourceAccessions match any of these strings. Accession numbers typically have a main number and a version, for example `NC_000001.11`.
       "A String",
     ],
-    "pageSize": 42, # Specifies the maximum number of results to return in a single page.
+    "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096.
     "pageToken": "A String", # 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.
   }
 
@@ -136,7 +136,7 @@ 

Method Details

{ "nextPageToken": "A String", # 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. "referenceSets": [ # The matching references sets. - { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. + { # A reference set is a set of references which typically comprise a reference assembly for a species, such as `GRCh38` which is representative of the human genome. A reference set defines a common coordinate space for comparing reference-aligned experimental data. A reference set contains 1 or more references. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "description": "A String", # Free text description of this reference set. "sourceUri": "A String", # The URI from which the references were obtained. "referenceIds": [ # The IDs of the reference objects that are part of this set. `Reference.md5checksum` must be unique within this set. @@ -148,7 +148,7 @@

Method Details

], "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string `reference.md5checksum` (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format. "id": "A String", # The server-generated reference set ID, unique across all reference sets. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different `ncbiTaxonId`, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome. }, ], }
diff --git a/docs/dyn/genomics_v1.variants.html b/docs/dyn/genomics_v1.variants.html index 4606cb2e9b3..3e8dada09e7 100644 --- a/docs/dyn/genomics_v1.variants.html +++ b/docs/dyn/genomics_v1.variants.html @@ -76,32 +76,35 @@

Genomics API . create(body, x__xgafv=None)

-

Creates a new variant.

+

Creates a new variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

delete(variantId, x__xgafv=None)

-

Deletes a variant.

+

Deletes a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(variantId, x__xgafv=None)

-

Gets a variant by ID.

+

Gets a variant by ID. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

import_(body, x__xgafv=None)

-

Creates variant data by asynchronously importing the provided information. 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.

+

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.

patch(variantId, body, x__xgafv=None, updateMask=None)

-

Updates a variant. This method supports patch semantics. Returns the modified variant without its calls.

+

Updates a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics. Returns the modified variant without its calls.

search(body, x__xgafv=None)

-

Gets a list of variants matching the criteria. Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).

+

Gets a list of variants matching the criteria. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).

+

+ stream(body, x__xgafv=None)

+

Returns a stream of all the variants matching the search request, ordered by reference name, position, and ID.

Method Details

create(body, x__xgafv=None) -
Creates a new variant.
+  
Creates a new variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
+{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
   "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
     "a_key": [
       "",
@@ -149,7 +152,7 @@ 

Method Details

Returns: An object of the form: - { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. + { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -195,7 +198,7 @@

Method Details

delete(variantId, x__xgafv=None) -
Deletes a variant.
+  
Deletes a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantId: string, The ID of the variant to be deleted. (required)
@@ -210,7 +213,7 @@ 

Method Details

get(variantId, x__xgafv=None) -
Gets a variant by ID.
+  
Gets a variant by ID. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantId: string, The ID of the variant. (required)
@@ -219,7 +222,7 @@ 

Method Details

Returns: An object of the form: - { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. + { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -265,7 +268,7 @@

Method Details

import_(body, x__xgafv=None) -
Creates variant data by asynchronously importing the provided information. 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.
+  
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.
 
 Args:
   body: object, The request body. (required)
@@ -286,12 +289,12 @@ 

Method Details

An object of the form: { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -300,7 +303,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }
@@ -308,14 +311,14 @@

Method Details

patch(variantId, body, x__xgafv=None, updateMask=None) -
Updates a variant. This method supports patch semantics. Returns the modified variant without its calls.
+  
Updates a variant. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) This method supports patch semantics. Returns the modified variant without its calls.
 
 Args:
   variantId: string, The ID of the variant to be updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
+{ # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
   "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
     "a_key": [
       "",
@@ -359,12 +362,12 @@ 

Method Details

} x__xgafv: string, V1 error format. - updateMask: string, An optional mask specifying which fields to update. At this time, mutable fields are [names][google.genomics.v1.Variant.names] and [info][google.genomics.v1.Variant.info]. Acceptable values are "names" and "info". If unspecified, all mutable fields will be updated. + updateMask: string, An optional mask specifying which fields to update. At this time, mutable fields are names and info. Acceptable values are "names" and "info". If unspecified, all mutable fields will be updated. Returns: An object of the form: - { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. + { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values). "a_key": [ "", @@ -410,7 +413,7 @@

Method Details

search(body, x__xgafv=None) -
Gets a list of variants matching the criteria. Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).
+  
Gets a list of variants matching the criteria. For the definitions of variants and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).
 
 Args:
   body: object, The request body. (required)
@@ -418,9 +421,9 @@ 

Method Details

{ # The variant search request. "end": "A String", # The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference. - "pageSize": 42, # The maximum number of variants to return. If unspecified, defaults to 5000. + "pageSize": 42, # The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000. "pageToken": "A String", # 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. - "maxCalls": 42, # The maximum number of calls to return. However, at least one variant will always be returned, even if it has more calls than this limit. If unspecified, defaults to 5000. + "maxCalls": 42, # The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000. "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0. "callSetIds": [ # Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all. Currently, variants with no calls from any call set will never be returned. "A String", @@ -440,7 +443,79 @@

Method Details

{ # The variant search response. "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results. "variants": [ # The list of matching Variants. - { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. + { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample. + "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values). + "a_key": [ + "", + ], + }, + "variantSetId": "A String", # The ID of the variant set this variant belongs to. + "end": "A String", # The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions. + "calls": [ # The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant. + { # A call represents the determination of genotype with respect to a particular variant. It may include associated information such as quality and phasing. For example, a call might assign a probability of 0.32 to the occurrence of a SNP named rs1234 in a call set with the name NA12345. + "info": { # A map of additional variant call information. This must be of the form map (string key mapping to a list of string values). + "a_key": [ + "", + ], + }, + "genotype": [ # The genotype of this variant call. Each value represents either the value of the `referenceBases` field or a 1-based index into `alternateBases`. If a variant had a `referenceBases` value of `T` and an `alternateBases` value of `["A", "C"]`, and the `genotype` was `[2, 1]`, that would mean the call represented the heterozygous value `CA` for this variant. If the `genotype` was instead `[0, 1]`, the represented value would be `TA`. Ordering of the genotype values is important if the `phaseset` is present. If a genotype is not called (that is, a `.` is present in the GT string) -1 is returned. + 42, + ], + "callSetId": "A String", # The ID of the call set this variant call belongs to. + "phaseset": "A String", # If this field is present, this variant call's genotype ordering implies the phase of the bases and is consistent with any other variant calls in the same reference sequence which have the same phaseset value. When importing data from VCF, if the genotype data was phased but no phase set was specified this field will be set to `*`. + "genotypeLikelihood": [ # The genotype likelihoods for this variant call. Each array entry represents how likely a specific genotype is for this call. The value ordering is defined by the GL tag in the VCF spec. If Phred-scaled genotype likelihood scores (PL) are available and log10(P) genotype likelihood scores (GL) are not, PL scores are converted to GL scores. If both are available, PL scores are stored in `info`. + 3.14, + ], + "callSetName": "A String", # The name of the call set this variant call belongs to. + }, + ], + "created": "A String", # The date this variant was created, in milliseconds from the epoch. + "referenceBases": "A String", # The reference bases for this variant. They start at the given position. + "filter": [ # A list of filters (normally quality filters) this variant has failed. `PASS` indicates this variant has passed all filters. + "A String", + ], + "start": "A String", # The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases. + "names": [ # Names for the variant, for example a RefSNP ID. + "A String", + ], + "alternateBases": [ # The bases that appear instead of the reference bases. + "A String", + ], + "referenceName": "A String", # The reference on which this variant occurs. (such as `chr20` or `X`) + "quality": 3.14, # A measure of how likely this variant is to be real. A higher value is better. + "id": "A String", # The server-generated variant ID, unique across all variants. + }, + ], + }
+
+ +
+ stream(body, x__xgafv=None) +
Returns a stream of all the variants matching the search request, ordered by reference name, position, and ID.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The stream variants request.
+    "variantSetId": "A String", # The variant set ID from which to stream variants.
+    "end": "A String", # The end of the window (0-based, exclusive) for which overlapping variants should be returned.
+    "projectId": "A String", # The Google Developers Console project ID or number which will be billed for this access. The caller must have WRITE access to this project. Required.
+    "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned.
+    "callSetIds": [ # Only return variant calls which belong to call sets with these IDs. Leaving this blank returns all variant calls.
+      "A String",
+    ],
+    "referenceName": "A String", # Required. Only return variants in this reference sequence.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    {
+    "variants": [
+      { # A variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.
         "info": { # A map of additional variant information. This must be of the form map (string key mapping to a list of string values).
           "a_key": [
             "",
diff --git a/docs/dyn/genomics_v1.variantsets.html b/docs/dyn/genomics_v1.variantsets.html
index e10d83478d0..4ce71248df3 100644
--- a/docs/dyn/genomics_v1.variantsets.html
+++ b/docs/dyn/genomics_v1.variantsets.html
@@ -76,32 +76,32 @@ 

Genomics API . create(body, x__xgafv=None)

-

Creates a new variant set. The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

+

Creates a new variant set. 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 provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.

delete(variantSetId, x__xgafv=None)

-

Deletes the contents of a variant set. The variant set object is not deleted.

+

Deletes the contents of a variant set. The variant set object is not deleted. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

export(variantSetId, body, x__xgafv=None)

-

Exports variant set data to an external destination.

+

Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

get(variantSetId, x__xgafv=None)

-

Gets a variant set by ID.

+

Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

patch(variantSetId, body, updateMask=None, x__xgafv=None)

-

Updates a variant set. This method supports patch semantics.

+

Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

search(body, x__xgafv=None)

-

Returns a list of all variant sets matching search criteria. Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).

+

Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).

Method Details

create(body, x__xgafv=None) -
Creates a new variant set. The provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.
+  
Creates a new variant set. 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 provided variant set must have a valid `datasetId` set - all other fields are optional. Note that the `id` field will be ignored, as this is assigned by the server.
 
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
+{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "metadata": [ # The metadata associated with this variant set.
     { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
       "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
@@ -117,12 +117,13 @@ 

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], } @@ -132,7 +133,7 @@

Method Details

Returns: An object of the form: - { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. + { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "metadata": [ # The metadata associated with this variant set. { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive. "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values). @@ -148,12 +149,13 @@

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], }
@@ -161,7 +163,7 @@

Method Details

delete(variantSetId, x__xgafv=None) -
Deletes the contents of a variant set. The variant set object is not deleted.
+  
Deletes the contents of a variant set. The variant set object is not deleted. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantSetId: string, The ID of the variant set to be deleted. (required)
@@ -176,7 +178,7 @@ 

Method Details

export(variantSetId, body, x__xgafv=None) -
Exports variant set data to an external destination.
+  
Exports variant set data to an external destination. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantSetId: string, Required. The ID of the variant set that contains variant data which should be exported. The caller must have READ access to this variant set. (required)
@@ -199,12 +201,12 @@ 

Method Details

An object of the form: { # This resource represents a long-running operation that is the result of a network API call. - "response": { # If importing [ReadGroupSets][google.genomics.v1.ReadGroupSet], an [ImportReadGroupSetsResponse][google.genomics.v1.ImportReadGroupSetsResponse] is returned. If importing [Variants][google.genomics.v1.Variant], an [ImportVariantsResponse][google.genomics.v1.ImportVariantsResponse] is returned. For exports, an empty response is returned. + "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For exports, an empty response is returned. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, - "error": { # 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][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. # The error result of the operation in case of failure. - "message": "A String", # 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][google.rpc.Status.details] field, or localized by the client. - "code": 42, # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. + "error": { # 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. # The error result of the operation in case of failure. + "message": "A String", # 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. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @ype with type URL. @@ -213,7 +215,7 @@

Method Details

}, "done": True or False, # If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available. "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` - "metadata": { # An [OperationMetadata][google.genomics.v1.OperationMetadata] object. This will always be returned with the [Operation][google.longrunning.Operation]. + "metadata": { # An OperationMetadata object. This will always be returned with the Operation. "a_key": "", # Properties of the object. Contains field @ype with type URL. }, }
@@ -221,7 +223,7 @@

Method Details

get(variantSetId, x__xgafv=None) -
Gets a variant set by ID.
+  
Gets a variant set by ID. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantSetId: string, Required. The ID of the variant set. (required)
@@ -230,7 +232,7 @@ 

Method Details

Returns: An object of the form: - { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. + { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "metadata": [ # The metadata associated with this variant set. { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive. "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values). @@ -246,12 +248,13 @@

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], }
@@ -259,14 +262,14 @@

Method Details

patch(variantSetId, body, updateMask=None, x__xgafv=None) -
Updates a variant set. This method supports patch semantics.
+  
Updates a variant set using patch semantics. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
 
 Args:
   variantSetId: string, The ID of the variant to be updated (must already exist). (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset.
+{ # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
   "metadata": [ # The metadata associated with this variant set.
     { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive.
       "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values).
@@ -282,23 +285,24 @@ 

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], } - updateMask: string, An optional mask specifying which fields to update. At this time, the only mutable field is [metadata][google.genomics.v1.VariantSet.metadata]. The only acceptable value is "metadata". If unspecified, all mutable fields will be updated. + updateMask: string, An optional mask specifying which fields to update. Supported fields: * metadata. Leaving `updateMask` unset is equivalent to specifying all mutable fields. x__xgafv: string, V1 error format. Returns: An object of the form: - { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. + { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "metadata": [ # The metadata associated with this variant set. { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive. "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values). @@ -314,12 +318,13 @@

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], }
@@ -327,7 +332,7 @@

Method Details

search(body, x__xgafv=None) -
Returns a list of all variant sets matching search criteria. Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).
+  
Returns a list of all variant sets matching search criteria. For the definitions of variant sets and other genomics resources, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) Implements [GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).
 
 Args:
   body: object, The request body. (required)
@@ -338,7 +343,7 @@ 

Method Details

"datasetIds": [ # Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned. "A String", ], - "pageSize": 42, # The maximum number of variant sets to return in a request. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. } x__xgafv: string, V1 error format. @@ -349,7 +354,7 @@

Method Details

{ # The search variant sets response. "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results. "variantSets": [ # The variant sets belonging to the requested dataset. - { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. + { # A variant set is a collection of call sets and variants. It contains summary statistics of those contents. A variant set belongs to a dataset. For more genomics resource definitions, see [Fundamentals of Google Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics) "metadata": [ # The metadata associated with this variant set. { # Metadata describes a single piece of variant call metadata. These data include a top level key and either a single value string (value) or a list of key-value pairs (info.) Value and info are mutually exclusive. "info": { # Remaining structured metadata key-value pairs. This must be of the form map (string key mapping to a list of string values). @@ -365,12 +370,13 @@

Method Details

"id": "A String", # User-provided ID field, not enforced by this API. Two or more pieces of structured metadata with identical id and key fields are considered equivalent. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the `referenceBounds` describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the `referenceBounds`. For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', `referenceBounds` would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The server-generated variant set ID, unique across all variant sets. "datasetId": "A String", # The dataset to which this variant set belongs. "referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], }, diff --git a/docs/dyn/genomics_v1beta2.annotationSets.html b/docs/dyn/genomics_v1beta2.annotationSets.html index 01b14da8065..c6d4d5deed1 100644 --- a/docs/dyn/genomics_v1beta2.annotationSets.html +++ b/docs/dyn/genomics_v1beta2.annotationSets.html @@ -88,7 +88,7 @@

Instance Methods

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. This method supports patch semantics.

search(body)

-

Searches for annotation sets that match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.

+

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.

update(annotationSetId, body)

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.

@@ -97,6 +97,11 @@

Method Details

create(body)
Creates a new annotation set. Caller must have WRITE permission for the associated dataset.
 
+The following fields must be provided when creating an annotation set:  
+- datasetId 
+- referenceSetId  
+All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).
+
 Args:
   body: object, The request body. (required)
     The object takes the form of:
@@ -111,8 +116,8 @@ 

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. } @@ -129,8 +134,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. }
@@ -163,8 +168,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. }
@@ -187,8 +192,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. } @@ -205,14 +210,14 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. }
search(body) -
Searches for annotation sets that match the given criteria. Results are returned in a deterministic order. Caller must have READ permission for the queried datasets.
+  
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.
 
 Args:
   body: object, The request body. (required)
@@ -220,7 +225,7 @@ 

Method Details

{ "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive). - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 128. The maximum value is 1024. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024. "datasetIds": [ # The dataset IDs to search within. Caller must have READ access to these datasets. "A String", ], @@ -248,8 +253,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. }, ], }
@@ -274,8 +279,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. } @@ -292,8 +297,8 @@

Method Details

"sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any. "type": "A String", # The type of annotations contained within this set. "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations. - "id": "A String", # The generated unique ID for this annotation set. - "datasetId": "A String", # The ID of the containing dataset. + "id": "A String", # The server-generated annotation set ID, unique across all annotation sets. + "datasetId": "A String", # The dataset to which this annotation set belongs. }
diff --git a/docs/dyn/genomics_v1beta2.annotations.html b/docs/dyn/genomics_v1beta2.annotations.html index 4ab30d7134c..89f077fe33d 100644 --- a/docs/dyn/genomics_v1beta2.annotations.html +++ b/docs/dyn/genomics_v1beta2.annotations.html @@ -91,7 +91,7 @@

Instance Methods

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

search(body)

-

Searches for annotations that match the given criteria. Results are returned ordered by start position. Annotations that have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.

+

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.

update(annotationId, body)

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.

@@ -103,13 +103,16 @@

Method Details

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 annotations.create. + Args: body: object, The request body. (required) The object takes the form of: { "annotations": [ # The annotations to be created. At most 4096 can be specified in a single request. - { # 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. A variant annotation is represented by one or more of these canonical types. 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'. + { # 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. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -142,7 +145,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -181,7 +184,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }, ], } @@ -197,7 +200,7 @@

Method Details

"message": "A String", # Error message for this status, if any. "code": 42, # The HTTP status code for this operation. }, - "annotation": { # 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. A variant annotation is represented by one or more of these canonical types. 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'. # The annotation, if any. + "annotation": { # 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. # The annotation, if any. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -230,7 +233,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -269,7 +272,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }, }, ], @@ -280,11 +283,20 @@

Method Details

create(body)
Creates a new annotation. Caller must have WRITE permission for the associated annotation set.
 
+
+The following fields must be provided when creating an annotation:  
+- annotationSetId 
+- position.referenceName or  position.referenceId  Transcripts 
+For annotations of type TRANSCRIPT, the following fields of annotation.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.
+
 Args:
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # 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. A variant annotation is represented by one or more of these canonical types. 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'.
+{ # 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.
   "info": { # A string which maps to an array of values.
     "a_key": [ # A string which maps to an array of values.
       "A String",
@@ -317,7 +329,7 @@ 

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -356,14 +368,14 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. } Returns: An object of the form: - { # 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. A variant annotation is represented by one or more of these canonical types. 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'. + { # 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. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -396,7 +408,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -435,7 +447,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }
@@ -444,7 +456,7 @@

Method Details

Deletes an annotation. Caller must have WRITE permission for the associated annotation set.
 
 Args:
-  annotationId: string, The ID of the annotation set to be deleted. (required)
+  annotationId: string, The ID of the annotation to be deleted. (required)
 
@@ -453,12 +465,12 @@

Method Details

Gets an annotation. Caller must have READ permission for the associated annotation set.
 
 Args:
-  annotationId: string, The ID of the annotation set to be retrieved. (required)
+  annotationId: string, The ID of the annotation to be retrieved. (required)
 
 Returns:
   An object of the form:
 
-    { # 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. A variant annotation is represented by one or more of these canonical types. 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'.
+    { # 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.
     "info": { # A string which maps to an array of values.
       "a_key": [ # A string which maps to an array of values.
         "A String",
@@ -491,7 +503,7 @@ 

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -530,7 +542,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }
@@ -539,11 +551,11 @@

Method Details

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.
 
 Args:
-  annotationId: string, The ID of the annotation set to be updated. (required)
+  annotationId: string, The ID of the annotation to be updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # 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. A variant annotation is represented by one or more of these canonical types. 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'.
+{ # 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.
   "info": { # A string which maps to an array of values.
     "a_key": [ # A string which maps to an array of values.
       "A String",
@@ -576,7 +588,7 @@ 

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -615,14 +627,14 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. } Returns: An object of the form: - { # 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. A variant annotation is represented by one or more of these canonical types. 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'. + { # 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. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -655,7 +667,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -694,13 +706,13 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }
search(body) -
Searches for annotations that match the given criteria. Results are returned ordered by start position. Annotations that have matching start positions are ordered deterministically. Caller must have READ permission for the queried annotation sets.
+  
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.
 
 Args:
   body: object, The request body. (required)
@@ -717,7 +729,7 @@ 

Method Details

"annotationSetIds": [ # The annotation sets to search within. The caller must have READ access to these annotation sets. Required. All queried annotation sets must have the same type. "A String", ], - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048. } @@ -727,7 +739,7 @@

Method Details

{ "nextPageToken": "A String", # 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. "annotations": [ # The matching annotations. - { # 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. A variant annotation is represented by one or more of these canonical types. 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'. + { # 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. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -760,7 +772,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -799,7 +811,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }, ], }
@@ -810,11 +822,11 @@

Method Details

Updates an annotation. The update must respect all mutability restrictions and other invariants described on the annotation resource. Caller must have WRITE permission for the associated dataset.
 
 Args:
-  annotationId: string, The ID of the annotation set to be updated. (required)
+  annotationId: string, The ID of the annotation to be updated. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # 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. A variant annotation is represented by one or more of these canonical types. 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'.
+{ # 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.
   "info": { # A string which maps to an array of values.
     "a_key": [ # A string which maps to an array of values.
       "A String",
@@ -847,7 +859,7 @@ 

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -886,14 +898,14 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. } Returns: An object of the form: - { # 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. A variant annotation is represented by one or more of these canonical types. 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'. + { # 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. "info": { # A string which maps to an array of values. "a_key": [ # A string which maps to an array of values. "A String", @@ -926,7 +938,7 @@

Method Details

], "geneId": "A String", # Google annotation ID of the gene affected by this variant. This should be provided when the variant is created. }, - "annotationSetId": "A String", # The ID of the containing annotation set. + "annotationSetId": "A String", # The annotation set to which this annotation belongs. "position": { # A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. # The position of this annotation on the reference sequence. "start": "A String", # The start position of the range on the reference, 0-based inclusive. "referenceId": "A String", # The ID of the Google Genomics reference associated with this range. @@ -965,7 +977,7 @@

Method Details

}, ], }, - "id": "A String", # The generated unique ID for this annotation. + "id": "A String", # The server-generated annotation ID, unique across all annotations. }
diff --git a/docs/dyn/genomics_v1beta2.callsets.html b/docs/dyn/genomics_v1beta2.callsets.html index 48c2455f7a2..dc628006210 100644 --- a/docs/dyn/genomics_v1beta2.callsets.html +++ b/docs/dyn/genomics_v1beta2.callsets.html @@ -231,7 +231,7 @@

Method Details

"A String", ], "name": "A String", # Only return call sets for which a substring of the name matches this string. - "pageSize": 42, # The maximum number of call sets to return. If unspecified, defaults to 1000. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. } diff --git a/docs/dyn/genomics_v1beta2.datasets.html b/docs/dyn/genomics_v1beta2.datasets.html index 951deda8ea5..cc075c44f62 100644 --- a/docs/dyn/genomics_v1beta2.datasets.html +++ b/docs/dyn/genomics_v1beta2.datasets.html @@ -163,7 +163,7 @@

Method Details

Args: pageToken: string, 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. projectNumber: string, Required. The project to list datasets for. - pageSize: integer, The maximum number of results returned by this request. If unspecified, defaults to 50. + pageSize: integer, The maximum number of results to return in a single page. If unspecified, defaults to 50. The maximum value is 1024. Returns: An object of the form: diff --git a/docs/dyn/genomics_v1beta2.jobs.html b/docs/dyn/genomics_v1beta2.jobs.html index fb3bafa8ffc..da99b72217d 100644 --- a/docs/dyn/genomics_v1beta2.jobs.html +++ b/docs/dyn/genomics_v1beta2.jobs.html @@ -143,7 +143,7 @@

Method Details

"A String", ], "createdAfter": "A String", # If specified, only jobs created on or after this date, given in milliseconds since Unix epoch, will be returned. - "pageSize": 42, # Specifies the number of results to return in a single page. Defaults to 128. The maximum value is 256. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 256. "pageToken": "A String", # The continuation token which is used to page through large result sets. To get the next page of results, set this parameter to the value of the nextPageToken from the previous response. "createdBefore": "A String", # If specified, only jobs created prior to this date, given in milliseconds since Unix epoch, will be returned. "projectNumber": "A String", # Required. Only return jobs which belong to this Google Developers Console project. diff --git a/docs/dyn/genomics_v1beta2.readgroupsets.html b/docs/dyn/genomics_v1beta2.readgroupsets.html index c52c1fd2137..098920f7037 100644 --- a/docs/dyn/genomics_v1beta2.readgroupsets.html +++ b/docs/dyn/genomics_v1beta2.readgroupsets.html @@ -79,12 +79,6 @@

Instance Methods

Returns the coveragebuckets Resource.

-

- align(body)

-

Aligns read data from existing read group sets or files from Google Cloud Storage. See the alignment and variant calling documentation for more details.

-

- call(body)

-

Calls variants on read data from existing read group sets or files from Google Cloud Storage. See the alignment and variant calling documentation for more details.

delete(readGroupSetId)

Deletes a read group set.

@@ -107,83 +101,6 @@

Instance Methods

update(readGroupSetId, body)

Updates a read group set.

Method Details

-
- align(body) -
Aligns read data from existing read group sets or files from Google Cloud Storage. See the  alignment and variant calling documentation for more details.
-
-Args:
-  body: object, The request body. (required)
-    The object takes the form of:
-
-{ # The read group set align request.
-    "interleavedFastqSource": { # Describes an interleaved FASTQ file source for alignment. # The interleaved FASTQ source files for alignment, where both members of each pair of reads are found on consecutive records within the same FASTQ file. Exactly one of readGroupSetId, bamSourceUris, interleavedFastqSource or pairedFastqSource must be provided.
-      "sourceUris": [ # A list of URIs pointing at interleaved FASTQ files in Google Cloud Storage which will be aligned. The caller must have READ permissions for these files.
-        "A String",
-      ],
-      "metadata": { # Optionally specifies the metadata to be associated with the final aligned read group set.
-        "readGroupName": "A String", # Optionally specifies the read group name for alignment from FASTQ.
-        "sampleName": "A String", # Optionally specifies the sample name for alignment from FASTQ.
-        "libraryName": "A String", # Optionally specifies the library name for alignment from FASTQ.
-        "platformName": "A String", # Optionally specifies the platform name for alignment from FASTQ. For example: CAPILLARY, LS454, ILLUMINA, SOLID, HELICOS, IONTORRENT, PACBIO.
-        "platformUnit": "A String", # Optionally specifies the platform unit for alignment from FASTQ. For example: flowcell-barcode.lane for Illumina or slide for SOLID.
-      },
-    },
-    "bamSourceUris": [ # The BAM source files for alignment. Exactly one of readGroupSetId, bamSourceUris, interleavedFastqSource or pairedFastqSource must be provided. The caller must have READ permissions for these files.
-      "A String",
-    ],
-    "pairedFastqSource": { # Describes a paired-end FASTQ file source for alignment. # The paired end FASTQ source files for alignment, where each member of a pair of reads are found in separate files. Exactly one of readGroupSetId, bamSourceUris, interleavedFastqSource or pairedFastqSource must be provided.
-      "secondSourceUris": [ # A list of URIs pointing at paired end FASTQ files in Google Cloud Storage which will be aligned. The second of each paired file should be specified here, in an order that matches the first of each paired file specified in firstSourceUris. For example: firstSourceUris: [file1_1.fq, file2_1.fq], secondSourceUris: [file1_2.fq, file2_2.fq]. The caller must have READ permissions for these files.
-        "A String",
-      ],
-      "metadata": { # Optionally specifies the metadata to be associated with the final aligned read group set.
-        "readGroupName": "A String", # Optionally specifies the read group name for alignment from FASTQ.
-        "sampleName": "A String", # Optionally specifies the sample name for alignment from FASTQ.
-        "libraryName": "A String", # Optionally specifies the library name for alignment from FASTQ.
-        "platformName": "A String", # Optionally specifies the platform name for alignment from FASTQ. For example: CAPILLARY, LS454, ILLUMINA, SOLID, HELICOS, IONTORRENT, PACBIO.
-        "platformUnit": "A String", # Optionally specifies the platform unit for alignment from FASTQ. For example: flowcell-barcode.lane for Illumina or slide for SOLID.
-      },
-      "firstSourceUris": [ # A list of URIs pointing at paired end FASTQ files in Google Cloud Storage which will be aligned. The first of each paired file should be specified here, in an order that matches the second of each paired file specified in secondSourceUris. For example: firstSourceUris: [file1_1.fq, file2_1.fq], secondSourceUris: [file1_2.fq, file2_2.fq]. The caller must have READ permissions for these files.
-        "A String",
-      ],
-    },
-    "readGroupSetId": "A String", # The ID of the read group set which will be aligned. A new read group set will be generated to hold the aligned data, the originals will not be modified. The caller must have READ permissions for this read group set. Exactly one of readGroupSetId, bamSourceUris, interleavedFastqSource or pairedFastqSource must be provided.
-    "datasetId": "A String", # Required. The ID of the dataset the newly aligned read group sets will belong to. The caller must have WRITE permissions to this dataset.
-  }
-
-
-Returns:
-  An object of the form:
-
-    { # The read group set align response.
-    "jobId": "A String", # A job ID that can be used to get status information.
-  }
-
- -
- call(body) -
Calls variants on read data from existing read group sets or files from Google Cloud Storage. See the  alignment and variant calling documentation for more details.
-
-Args:
-  body: object, The request body. (required)
-    The object takes the form of:
-
-{ # The read group set call request.
-    "sourceUris": [ # A list of URIs pointing at BAM files in Google Cloud Storage which will be called. FASTQ files are not allowed. The caller must have READ permissions for these files. One of readGroupSetId or sourceUris must be provided.
-      "A String",
-    ],
-    "readGroupSetId": "A String", # The IDs of the read group sets which will be called. The caller must have READ permissions for these read group sets. One of readGroupSetId or sourceUris must be provided.
-    "datasetId": "A String", # Required. The ID of the dataset the called variants will belong to. The caller must have WRITE permissions to this dataset.
-  }
-
-
-Returns:
-  An object of the form:
-
-    { # The read group set call response.
-    "jobId": "A String", # A job ID that can be used to get status information.
-  }
-
-
delete(readGroupSetId)
Deletes a read group set.
@@ -208,10 +125,10 @@ 

Method Details

"referenceNames": [ # The reference names to export. If this is not specified, all reference sequences, including unmapped reads, are exported. Use * to export only unmapped reads. "A String", ], - "readGroupSetIds": [ # Required. The IDs of the read group sets to export. + "readGroupSetIds": [ # Required. The IDs of the read group sets to export. The caller must have READ access to these read group sets. "A String", ], - "projectNumber": "A String", # Required. The Google Developers Console project number that owns this export. + "projectNumber": "A String", # Required. The Google Developers Console project number that owns this export. The caller must have WRITE access to this project. } @@ -258,7 +175,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -268,7 +185,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. @@ -289,7 +206,7 @@

Method Details

- Tags will be converted to strings - tag types are not preserved - Comments (@CO) in the input file header are not imported - Original order of reference headers is not preserved -- Any reverse stranded unmapped reads will be reverse complemented, and their qualities (and "BQ" tag, if any) will be reversed +- Any reverse stranded unmapped reads will be reverse complemented, and their qualities (also the "BQ" and "OQ" tags, if any) will be reversed - Unmapped reads will be stripped of positional information (referenceName and position) Args: @@ -348,7 +265,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -358,7 +275,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. @@ -399,7 +316,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -409,7 +326,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. @@ -438,7 +355,7 @@

Method Details

"A String", ], "name": "A String", # Only return read group sets for which a substring of the name matches this string. - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 1024. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024. } @@ -473,7 +390,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -483,7 +400,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. @@ -532,7 +449,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -542,7 +459,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. @@ -583,7 +500,7 @@

Method Details

"prevProgramId": "A String", # The ID of the program run before this one. "id": "A String", # The user specified locally unique ID of the program. Used along with prevProgramId to define an ordering between programs. "version": "A String", # The version of the program run. - "name": "A String", # The name of the program. + "name": "A String", # The display name of the program. This is typically the colloquial name of the tool used, for example 'bwa' or 'picard'. }, ], "sampleId": "A String", # The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. @@ -593,7 +510,7 @@

Method Details

"instrumentModel": "A String", # The instrument model used as part of this experiment. This maps to sequencing technology in BAM. "platformUnit": "A String", # The platform unit used as part of this experiment e.g. flowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the }, - "referenceSetId": "A String", # The reference set the reads in this read group are aligned to. Required if there are any read alignments. + "referenceSetId": "A String", # The reference set to which the reads in this read group are aligned. "id": "A String", # The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. "datasetId": "A String", # The ID of the dataset this read group belongs to. "description": "A String", # A free-form text description of this read group. diff --git a/docs/dyn/genomics_v1beta2.reads.html b/docs/dyn/genomics_v1beta2.reads.html index 50352f78077..84a28b791e2 100644 --- a/docs/dyn/genomics_v1beta2.reads.html +++ b/docs/dyn/genomics_v1beta2.reads.html @@ -84,7 +84,7 @@

Method Details

If a target positional range is specified, search returns all reads whose alignment to the reference genome overlap the range. A query which specifies only read group set IDs yields all reads in those read group sets, including unmapped reads. -All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (reference sequence & position). Reads with equivalent genomic coordinates are returned in a deterministic order. +All reads returned (including reads on subsequent pages) are ordered by genomic coordinate (by reference sequence, then position). Reads 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 reads in the same order across their respective streams of paginated responses. Implements GlobalAllianceApi.searchReads. @@ -99,10 +99,10 @@

Method Details

"readGroupIds": [ # The IDs of the read groups within which to search for reads. All specified read groups must belong to the same read group sets. Must specify one of readGroupSetIds or readGroupIds. "A String", ], - "pageSize": 42, # Specifies number of results to return in a single page. If unspecified, it will default to 256. The maximum value is 2048. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 2048. "start": "A String", # The start position of the range on the reference, 0-based inclusive. If specified, referenceName must also be specified. "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. - "referenceName": "A String", # The reference sequence name, for example chr1, 1, or chrX. If set to *, only unmapped reads are returned. + "referenceName": "A String", # The reference sequence name, for example chr1, 1, or chrX. If set to *, only unmapped reads are returned. If unspecified, all reads (mapped and unmapped) returned. "end": "A String", # The end position of the range on the reference, 0-based exclusive. If specified, referenceName must also be specified. } @@ -122,15 +122,15 @@

Method Details

"A String", ], }, - "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400) - "readGroupSetId": "A String", # The ID of the read group set this read belongs to. (Every read must belong to exactly one read group set.) - "alignedQuality": [ # The quality of the read sequence contained in this alignment record. alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. + "duplicateFragment": True or False, # The fragment is a PCR or optical duplicate (SAM flag 0x400). + "readGroupSetId": "A String", # The ID of the read group set this read belongs to. A read belongs to exactly one read group set. + "alignedQuality": [ # The quality of the read sequence contained in this alignment record. (equivalent to QUAL in SAM). alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. 42, ], - "failedVendorQualityChecks": True or False, # SAM flag 0x200 + "failedVendorQualityChecks": True or False, # Whether this read did not pass filters, such as platform or vendor quality controls (SAM flag 0x200). "fragmentName": "A String", # The fragment name. Equivalent to QNAME (query template name) in SAM. "readNumber": 42, # The read number in sequencing. 0-based and less than numberReads. This field replaces SAM flag 0x40 and 0x80. - "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2) + "properPlacement": True or False, # The orientation and the distance between reads from the fragment are consistent with the sequencing protocol (SAM flag 0x2). "nextMatePosition": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of the primary alignment of the (readNumber+1)%numberReads read in the fragment. It replaces mate position and mate strand in SAM. This field will be unset if that read is unmapped or if the fragment only has a single read. "position": "A String", # The 0-based offset from the start of the forward strand for that reference. "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand. @@ -140,9 +140,9 @@

Method Details

"numberReads": 42, # The number of reads in the fragment (extension to SAM flag 0x1). "fragmentLength": 42, # The observed length of the fragment, equivalent to TLEN in SAM. "secondaryAlignment": True or False, # Whether this alignment is secondary. Equivalent to SAM flag 0x100. A secondary alignment represents an alternative to the primary alignment for this read. Aligners may return secondary alignments if a read can map ambiguously to multiple coordinates in the genome. By convention, each read has one and only one alignment where both secondaryAlignment and supplementaryAlignment are false. - "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, without CIGAR operations applied. alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. + "alignedSequence": "A String", # The bases of the read sequence contained in this alignment record, without CIGAR operations applied (equivalent to SEQ in SAM). alignedSequence and alignedQuality may be shorter than the full read sequence and quality. This will occur if the alignment is part of a chimeric alignment, or if the read was trimmed. When this occurs, the CIGAR for this read will begin/end with a hard clip operator that will indicate the length of the excised sequence. "id": "A String", # The unique ID for this read. This is a generated unique ID, not to be confused with fragmentName. - "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field will be unset if the read is unmapped. + "alignment": { # A linear alignment can be represented by one CIGAR string. Describes the mapped position and local alignment of the read to the reference. # The linear alignment for this alignment record. This field is null for unmapped reads. "position": { # An abstraction for referring to a genomic position, in relation to some already known reference. For now, represents a genomic position as a reference name, a base number on that reference (0-based), and a determination of forward or reverse strand. # The position of this alignment. "position": "A String", # The 0-based offset from the start of the forward strand for that reference. "reverseStrand": True or False, # Whether this position is on the reverse strand, as opposed to the forward strand. @@ -156,8 +156,10 @@

Method Details

}, ], "mappingQuality": 42, # The mapping quality of this alignment. Represents how likely the read maps to this position as opposed to other locations. + # + # Specifically, this is -10 log10 Pr(mapping position is wrong), rounded to the nearest integer. }, - "readGroupId": "A String", # The ID of the read group this read belongs to. (Every read must belong to exactly one read group.) + "readGroupId": "A String", # The ID of the read group this read belongs to. A read belongs to exactly one read group. This is a server-generated ID (not SAM's RG tag). }, ], }
diff --git a/docs/dyn/genomics_v1beta2.references.bases.html b/docs/dyn/genomics_v1beta2.references.bases.html index 7d228a07810..f91d78432b4 100644 --- a/docs/dyn/genomics_v1beta2.references.bases.html +++ b/docs/dyn/genomics_v1beta2.references.bases.html @@ -90,7 +90,7 @@

Method Details

Args: referenceId: string, The ID of the reference. (required) end: string, The end position (0-based, exclusive) of this query. Defaults to the length of this reference. - pageSize: integer, Specifies the maximum number of bases to return in a single page. + pageSize: integer, The maximum number of bases to return in a single page. If unspecified, defaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base pairs). pageToken: string, 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. start: string, The start position (0-based) of this query. Defaults to 0. diff --git a/docs/dyn/genomics_v1beta2.references.html b/docs/dyn/genomics_v1beta2.references.html index fe84df3bfe7..71367507c7b 100644 --- a/docs/dyn/genomics_v1beta2.references.html +++ b/docs/dyn/genomics_v1beta2.references.html @@ -100,14 +100,14 @@

Method Details

{ # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. "name": "A String", # The name of this reference, for example 22. - "sourceURI": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair. + "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file. "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26. "A String", ], "length": "A String", # The length of this reference's sequence. "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format. "id": "A String", # The Google generated immutable ID of the reference. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. }
@@ -130,7 +130,7 @@

Method Details

"accessions": [ # If present, return references for which the accession matches this string. Best to give a version number, for example GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences. "A String", ], - "pageSize": 42, # Specifies the maximum number of results to return in a single page. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096. } @@ -142,14 +142,14 @@

Method Details

"references": [ # The matching references. { # A reference is a canonical assembled DNA sequence, intended to act as a reference coordinate space for other genomic annotations. A single reference might represent the human chromosome 1 or mitochandrial DNA, for instance. A reference belongs to one or more reference sets. "name": "A String", # The name of this reference, for example 22. - "sourceURI": "A String", # The URI from which the sequence was obtained. Specifies a FASTA format file/string with one name, sequence pair. + "sourceURI": "A String", # The URI from which the sequence was obtained. Typically specifies a FASTA format file. "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally with a version number, for example GCF_000001405.26. "A String", ], "length": "A String", # The length of this reference's sequence. "md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this is equivalent to SQ:M5 in SAM). This value is represented in lower case hexadecimal format. "id": "A String", # The Google generated immutable ID of the reference. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) if not specified by the containing reference set. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human. }, ], }
diff --git a/docs/dyn/genomics_v1beta2.referencesets.html b/docs/dyn/genomics_v1beta2.referencesets.html index 7eef51cdcc5..943ce17a5f8 100644 --- a/docs/dyn/genomics_v1beta2.referencesets.html +++ b/docs/dyn/genomics_v1beta2.referencesets.html @@ -105,7 +105,7 @@

Method Details

], "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string reference.md5checksum (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format. "id": "A String", # The Google generated immutable ID of the reference set. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome. }
@@ -127,7 +127,7 @@

Method Details

"accessions": [ # If present, return references for which the accession matches any of these strings. Best to give a version number, for example GCF_000001405.26. If only the main accession number is given then all records with that main accession will be returned, whichever version. Note that different versions will have different sequences. "A String", ], - "pageSize": 42, # Specifies the maximum number of results to return in a single page. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. The maximum value is 4096. "pageToken": "A String", # 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. } @@ -150,7 +150,7 @@

Method Details

], "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The checksum is computed by sorting all lower case hexidecimal string reference.md5checksum (for all reference in this set) in ascending lexicographic order, concatenating, and taking the MD5 of that value. The resulting value is represented in lower case hexadecimal format. "id": "A String", # The Google generated immutable ID of the reference set. - "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (e.g. 9606->human) indicating the species which this assembly is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, e.g. EBV in a human reference genome. + "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human) indicating the species which this reference set is intended to model. Note that contained references may specify a different ncbiTaxonId, as assemblies may contain reference sequences which do not belong to the modeled species, for example EBV in a human reference genome. }, ], }
diff --git a/docs/dyn/genomics_v1beta2.variants.html b/docs/dyn/genomics_v1beta2.variants.html index 9943984abfe..d220fb33f50 100644 --- a/docs/dyn/genomics_v1beta2.variants.html +++ b/docs/dyn/genomics_v1beta2.variants.html @@ -264,9 +264,9 @@

Method Details

{ # The variant search request. "end": "A String", # The end of the window, 0-based exclusive. If unspecified or 0, defaults to the length of the reference. - "pageSize": 42, # The maximum number of variants to return. If unspecified, defaults to 5000. + "pageSize": 42, # The maximum number of variants to return in a single page. If unspecified, defaults to 5000. The maximum value is 10000. "start": "A String", # The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. If unspecified, defaults to 0. - "maxCalls": 42, # The maximum number of calls to return. However, at least one variant will always be returned, even if it has more calls than this limit. If unspecified, defaults to 5000. + "maxCalls": 42, # The maximum number of calls to return in a single page. Note that this limit may be exceeded in the event that a matching variant contains more calls than the requested maximum. If unspecified, defaults to 5000. The maximum value is 10000. "pageToken": "A String", # 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. "callSetIds": [ # Only return variant calls which belong to call sets with these ids. Leaving this blank returns all variant calls. If a variant has no calls belonging to any of these call sets, it won't be returned at all. Currently, variants with no calls from any call set will never be returned. "A String", diff --git a/docs/dyn/genomics_v1beta2.variantsets.html b/docs/dyn/genomics_v1beta2.variantsets.html index 7dc73e3f5a3..57ebb6ee269 100644 --- a/docs/dyn/genomics_v1beta2.variantsets.html +++ b/docs/dyn/genomics_v1beta2.variantsets.html @@ -116,9 +116,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -146,9 +149,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -220,9 +226,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -247,7 +256,7 @@

Method Details

importVariants(variantSetId, body)
Creates variant data by asynchronously importing the provided information.
 
-The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting INFO fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.
+The variants for import will be merged with any existing data and each other according to the behavior of mergeVariants. In particular, this means for merged VCF variants that have conflicting info fields, some data will be arbitrarily discarded. As a special case, for single-sample VCF files, QUAL and FILTER fields will be moved to the call level; these are sometimes interpreted in a call-specific context. Imported VCF headers are appended to the metadata already in a variant set.
 
 Args:
   variantSetId: string, Required. The variant set to which variant data should be imported. (required)
@@ -259,7 +268,7 @@ 

Method Details

"sourceUris": [ # A list of URIs referencing variant files in Google Cloud Storage. URIs can include wildcards as described here. Note that recursive wildcards ('**') are not supported. "A String", ], - "format": "A String", # The format of the variant data being imported. If unspecified, defaults to to "VCF". + "format": "A String", # The format of the variant data being imported. If unspecified, defaults to "VCF". } @@ -345,9 +354,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -375,9 +387,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -413,7 +428,7 @@

Method Details

"datasetIds": [ # Exactly one dataset ID must be provided here. Only variant sets which belong to this dataset will be returned. "A String", ], - "pageSize": 42, # The maximum number of variant sets to return in a request. + "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 1024. } @@ -427,9 +442,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -465,9 +483,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. @@ -495,9 +516,12 @@

Method Details

"referenceBounds": [ # A list of all references used by the variants in a variant set with associated coordinate upper bounds for each one. { # ReferenceBound records an upper bound for the starting coordinate of variants in a particular reference. "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any variant in the reference sequence. - "referenceName": "A String", # The reference the bound is associate with. + "referenceName": "A String", # The name of the reference associated with this reference bound. }, ], + "referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set describes the alignment provenance of the variant set, while the referenceBounds describe the shape of the actual variant data. The reference set's reference names are a superset of those found in the referenceBounds. + # + # For example, given a variant set that is mapped to the GRCh38 reference set and contains a single variant on reference 'X', referenceBounds would contain only an entry for 'X', while the associated reference set enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc. "id": "A String", # The Google-generated ID of the variant set. Immutable. "datasetId": "A String", # The dataset to which this variant set belongs. Immutable. "metadata": [ # The metadata associated with this variant set. diff --git a/docs/dyn/gmail_v1.users.html b/docs/dyn/gmail_v1.users.html index 4fe522290ce..03f01734cf0 100644 --- a/docs/dyn/gmail_v1.users.html +++ b/docs/dyn/gmail_v1.users.html @@ -149,7 +149,7 @@

Method Details

"labelIds": [ # List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. "A String", ], - "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the new Cloud Pub/Sub "v1beta2" topic naming format). + "topicName": "A String", # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name **must** already exist in Cloud Pub/Sub and you **must** have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). # # Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). "labelFilterAction": "A String", # Filtering behavior of labelIds list specified. diff --git a/docs/dyn/iam_v1.html b/docs/dyn/iam_v1.html new file mode 100644 index 00000000000..6b60ba41b04 --- /dev/null +++ b/docs/dyn/iam_v1.html @@ -0,0 +1,103 @@ + + + +

Google Identity and Access Management API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/iam_v1.projects.html b/docs/dyn/iam_v1.projects.html new file mode 100644 index 00000000000..77e1a4e7a24 --- /dev/null +++ b/docs/dyn/iam_v1.projects.html @@ -0,0 +1,82 @@ + + + +

Google Identity and Access Management API . projects

+

Instance Methods

+

+ serviceAccounts() +

+

Returns the serviceAccounts Resource.

+ + \ No newline at end of file diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.html b/docs/dyn/iam_v1.projects.serviceAccounts.html new file mode 100644 index 00000000000..44e6d67478a --- /dev/null +++ b/docs/dyn/iam_v1.projects.serviceAccounts.html @@ -0,0 +1,502 @@ + + + +

Google Identity and Access Management API . projects . serviceAccounts

+

Instance Methods

+

+ keys() +

+

Returns the keys Resource.

+ +

+ create(name, body, x__xgafv=None)

+

Creates a service account and returns it.

+

+ delete(name, x__xgafv=None)

+

Deletes a service acount.

+

+ get(name, x__xgafv=None)

+

Gets a ServiceAccount

+

+ getIamPolicy(resource, x__xgafv=None)

+

Returns the IAM access control policy for specified IAM resource.

+

+ list(name, pageToken=None, x__xgafv=None, pageSize=None)

+

Lists service accounts for a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ setIamPolicy(resource, body, x__xgafv=None)

+

Sets the IAM access control policy for the specified IAM resource.

+

+ signBlob(name, body, x__xgafv=None)

+

Signs a blob using a service account.

+

+ testIamPermissions(resource, body, x__xgafv=None)

+

Tests the specified permissions against the IAM access control policy for the specified IAM resource.

+

+ update(name, body, x__xgafv=None)

+

Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.

+

Method Details

+
+ create(name, body, x__xgafv=None) +
Creates a service account and returns it.
+
+Args:
+  name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The service account create request.
+    "serviceAccount": { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. # The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name .
+      "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+      "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+      "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+      "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+      "etag": "A String", # Used to perform a consistent read-modify-write.
+      "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+      "email": "A String", # @OutputOnly Email address of the service account.
+    },
+    "accountId": "A String", # Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+    "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+    "etag": "A String", # Used to perform a consistent read-modify-write.
+    "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+    "email": "A String", # @OutputOnly Email address of the service account.
+  }
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a service acount.
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(name, x__xgafv=None) +
Gets a ServiceAccount
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+    "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+    "etag": "A String", # Used to perform a consistent read-modify-write.
+    "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+    "email": "A String", # @OutputOnly Email address of the service account.
+  }
+
+ +
+ getIamPolicy(resource, x__xgafv=None) +
Returns the IAM access control policy for specified IAM resource.
+
+Args:
+  resource: string, 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)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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).
+    "rules": [
+      { # A rule to be applied in a Policy.
+        "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
+          "A String",
+        ],
+        "description": "A String", # Human-readable description of the rule.
+        "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+          "A String",
+        ],
+        "action": "A String", # Required
+        "conditions": [ # Additional restrictions that must be met
+          { # A condition to be met.
+            "iam": "A String", # Trusted attributes supplied by the IAM system.
+            "svc": "A String", # Trusted attributes discharged by the service.
+            "value": "A String", # The object of the condition. Exactly one of these must be set.
+            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+              "A String",
+            ],
+            "op": "A String", # An operator to apply the subject with.
+          },
+        ],
+        "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+          { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
+            "counter": { # Options for counters # Counter options.
+              "field": "A String", # The field value to attribute.
+              "metric": "A String", # The metric to update.
+            },
+            "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+            },
+            "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+            },
+          },
+        ],
+        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+          "A String",
+        ],
+      },
+    ],
+    "bindings": [ # 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.
+      { # Associates `members` with a `role`.
+        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+      },
+    ],
+    "version": 42, # Version of the `Policy`. The default version is 0.
+    "etag": "A String", # `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.
+  }
+
+ +
+ list(name, pageToken=None, x__xgafv=None, pageSize=None) +
Lists service accounts for a project.
+
+Args:
+  name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
+  pageToken: string, Optional pagination token returned in an earlier [ListServiceAccountsResponse.next_page_token].
+  x__xgafv: string, V1 error format.
+  pageSize: integer, Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the [ListServiceAccountsResponse.next_page_token] in a subsequent request.
+
+Returns:
+  An object of the form:
+
+    { # The service account list response.
+    "nextPageToken": "A String", # To retrieve the next page of results, set [ListServiceAccountsRequest.page_token] to this value.
+    "accounts": [ # The list of matching service accounts.
+      { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+        "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+        "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+        "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+        "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+        "etag": "A String", # Used to perform a consistent read-modify-write.
+        "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+        "email": "A String", # @OutputOnly Email address of the service account.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ setIamPolicy(resource, body, x__xgafv=None) +
Sets the IAM access control policy for the specified IAM resource.
+
+Args:
+  resource: string, 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)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+      "rules": [
+        { # A rule to be applied in a Policy.
+          "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
+            "A String",
+          ],
+          "description": "A String", # Human-readable description of the rule.
+          "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+            "A String",
+          ],
+          "action": "A String", # Required
+          "conditions": [ # Additional restrictions that must be met
+            { # A condition to be met.
+              "iam": "A String", # Trusted attributes supplied by the IAM system.
+              "svc": "A String", # Trusted attributes discharged by the service.
+              "value": "A String", # The object of the condition. Exactly one of these must be set.
+              "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+              "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+                "A String",
+              ],
+              "op": "A String", # An operator to apply the subject with.
+            },
+          ],
+          "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+            { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
+              "counter": { # Options for counters # Counter options.
+                "field": "A String", # The field value to attribute.
+                "metric": "A String", # The metric to update.
+              },
+              "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+              },
+              "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+              },
+            },
+          ],
+          "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+            "A String",
+          ],
+        },
+      ],
+      "bindings": [ # 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.
+        { # Associates `members` with a `role`.
+          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+            "A String",
+          ],
+        },
+      ],
+      "version": 42, # Version of the `Policy`. The default version is 0.
+      "etag": "A String", # `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.
+    },
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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).
+    "rules": [
+      { # A rule to be applied in a Policy.
+        "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
+          "A String",
+        ],
+        "description": "A String", # Human-readable description of the rule.
+        "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
+          "A String",
+        ],
+        "action": "A String", # Required
+        "conditions": [ # Additional restrictions that must be met
+          { # A condition to be met.
+            "iam": "A String", # Trusted attributes supplied by the IAM system.
+            "svc": "A String", # Trusted attributes discharged by the service.
+            "value": "A String", # The object of the condition. Exactly one of these must be set.
+            "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
+            "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+              "A String",
+            ],
+            "op": "A String", # An operator to apply the subject with.
+          },
+        ],
+        "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
+          { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
+            "counter": { # Options for counters # Counter options.
+              "field": "A String", # The field value to attribute.
+              "metric": "A String", # The metric to update.
+            },
+            "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+            },
+            "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+            },
+          },
+        ],
+        "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+          "A String",
+        ],
+      },
+    ],
+    "bindings": [ # 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.
+      { # Associates `members` with a `role`.
+        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
+          "A String",
+        ],
+      },
+    ],
+    "version": 42, # Version of the `Policy`. The default version is 0.
+    "etag": "A String", # `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.
+  }
+
+ +
+ signBlob(name, body, x__xgafv=None) +
Signs a blob using a service account.
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The service account sign blob request.
+    "bytesToSign": "A String", # The bytes to sign
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The service account sign blob response.
+    "keyId": "A String", # The id of the key used to sign the blob.
+    "signature": "A String", # The signed blob.
+  }
+
+ +
+ testIamPermissions(resource, body, x__xgafv=None) +
Tests the specified permissions against the IAM access control policy for the specified IAM resource.
+
+Args:
+  resource: string, 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)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
+      "A String",
+    ],
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+      "A String",
+    ],
+  }
+
+ +
+ update(name, body, x__xgafv=None) +
Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}". (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+  "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+  "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+  "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+  "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+  "etag": "A String", # Used to perform a consistent read-modify-write.
+  "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+  "email": "A String", # @OutputOnly Email address of the service account.
+}
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
+    "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
+    "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
+    "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
+    "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
+    "etag": "A String", # Used to perform a consistent read-modify-write.
+    "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
+    "email": "A String", # @OutputOnly Email address of the service account.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html new file mode 100644 index 00000000000..56b7b2d70e7 --- /dev/null +++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html @@ -0,0 +1,177 @@ + + + +

Google Identity and Access Management API . projects . serviceAccounts . keys

+

Instance Methods

+

+ create(name, body, x__xgafv=None)

+

Creates a service account key and returns it.

+

+ delete(name, x__xgafv=None)

+

Deletes a service account key.

+

+ get(name, x__xgafv=None)

+

Gets the ServiceAccountKey by key id.

+

+ list(name, keyTypes=None, x__xgafv=None)

+

Lists service account keys

+

Method Details

+
+ create(name, body, x__xgafv=None) +
Creates a service account key and returns it.
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The service account key create request.
+    "privateKeyType": "A String", # The type of the key requested. GOOGLE_CREDENTIALS is the default key type.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
+    "privateKeyType": "A String", # The type of the private key.
+    "privateKeyData": "A String", # The key data.
+    "validBeforeTime": "A String", # The key can be used before this timestamp.
+    "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+    "validAfterTime": "A String", # The key can be used after this timestamp.
+  }
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a service account key.
+
+Args:
+  name: string, The resource name of the service account key in the format "projects/{project}/serviceAccounts/{account}/keys/{key}". Using '-' as a wildcard for the project will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(name, x__xgafv=None) +
Gets the ServiceAccountKey by key id.
+
+Args:
+  name: string, The resource name of the service account key in the format "projects/{project}/serviceAccounts/{account}/keys/{key}". Using '-' as a wildcard for the project will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
+    "privateKeyType": "A String", # The type of the private key.
+    "privateKeyData": "A String", # The key data.
+    "validBeforeTime": "A String", # The key can be used before this timestamp.
+    "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+    "validAfterTime": "A String", # The key can be used after this timestamp.
+  }
+
+ +
+ list(name, keyTypes=None, x__xgafv=None) +
Lists service account keys
+
+Args:
+  name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
+  keyTypes: string, The type of keys the user wants to list. If empty, all key types are included in the response. Duplicate key types are not allowed. (repeated)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The service account keys list response.
+    "keys": [ # The public keys for the service account.
+      { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
+        "privateKeyType": "A String", # The type of the private key.
+        "privateKeyData": "A String", # The key data.
+        "validBeforeTime": "A String", # The key can be used before this timestamp.
+        "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
+        "validAfterTime": "A String", # The key can be used after this timestamp.
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html index b5325ea20ad..eb3f8614ba6 100644 --- a/docs/dyn/identitytoolkit_v3.relyingparty.html +++ b/docs/dyn/identitytoolkit_v3.relyingparty.html @@ -89,6 +89,9 @@

Instance Methods

getOobConfirmationCode(body)

Get a code for user action confirmation.

+

+ getProjectConfig()

+

Get project configuration.

getPublicKeys()

Get token signing public key.

@@ -101,12 +104,21 @@

Instance Methods

setAccountInfo(body)

Set account info for a user.

+

+ signOutUser(body)

+

Sign out user.

+

+ signupNewUser(body)

+

Signup new user.

uploadAccount(body)

Batch upload existing user accounts.

verifyAssertion(body)

Verifies the assertion returned by the IdP.

+

+ verifyCustomToken(body)

+

Verifies the developer asserted ID token.

verifyPassword(body)

Verifies the user entered password.

@@ -137,9 +149,13 @@

Method Details

An object of the form: { # Response of creating the IDP authentication URL. + "sessionId": "A String", # Session ID which should be passed in the following verifyAssertion request. "kind": "identitytoolkit#CreateAuthUriResponse", # The fixed string identitytoolkit#CreateAuthUriResponse". "captchaRequired": True or False, # True if captcha is required. "registered": True or False, # Whether the user is registered if the identifier is an email. + "allProviders": [ # all providers the user has once used to do federated login + "A String", + ], "forExistingProvider": True or False, # True if the authUri is for user's existing provider. "providerId": "A String", # The provider ID of the auth URI. "authUri": "A String", # The URI used by the IDP to authenticate the user. @@ -155,6 +171,7 @@

Method Details

The object takes the form of: { # Request to delete account. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. "localId": "A String", # The local ID of the user. } @@ -177,6 +194,7 @@

Method Details

{ # Request to download user account in batch. "nextPageToken": "A String", # The token for the next page. This should be taken from the previous response. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. "maxResults": 42, # The max number of results to return in the response. } @@ -202,6 +220,7 @@

Method Details

"federatedId": "A String", # User's identifier at IDP. "providerId": "A String", # 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. "displayName": "A String", # The user's display name at the IDP. + "email": "A String", # User's email at IDP. "photoUrl": "A String", # The user's photo url at the IDP. }, ], @@ -252,6 +271,7 @@

Method Details

"federatedId": "A String", # User's identifier at IDP. "providerId": "A String", # 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. "displayName": "A String", # The user's display name at the IDP. + "email": "A String", # User's email at IDP. "photoUrl": "A String", # The user's photo url at the IDP. }, ], @@ -289,6 +309,31 @@

Method Details

{ # Response of getting a code for user confirmation (reset password, change email etc.). "kind": "identitytoolkit#GetOobConfirmationCodeResponse", # The fixed string "identitytoolkit#GetOobConfirmationCodeResponse". "oobCode": "A String", # The code to be send to the user. + "email": "A String", # The email address that the email is sent to. + }
+
+ +
+ getProjectConfig() +
Get project configuration.
+
+Args:
+
+Returns:
+  An object of the form:
+
+    { # Response of getting the project configuration.
+    "projectId": "A String", # Project ID of the relying party.
+    "apiKey": "A String", # Browser API key, needed when making http request to Apiary.
+    "allowPasswordUser": True or False, # Whether to allow password user sign in or sign up.
+    "idpConfig": [ # OAuth2 provider configuration.
+      { # Template for a single idp configuration.
+        "experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IDP.
+        "enabled": True or False, # Whether this IDP is enabled.
+        "clientId": "A String", # OAuth2 client ID.
+        "provider": "A String", # OAuth2 provider.
+      },
+    ],
   }
@@ -356,15 +401,18 @@

Method Details

The object takes the form of: { # Request to set the account information. + "instanceId": "A String", # Instance id token of the app. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. "displayName": "A String", # The name of the user. "localId": "A String", # The local ID of the user. "validSince": "A String", # Timestamp in seconds for valid login token. - "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login. + "photoUrl": "A String", # The photo url of the user. "captchaResponse": "A String", # Response to the captcha. "emailVerified": True or False, # Mark the email as verified or not. "provider": [ # The associated IDPs of the user. "A String", ], + "upgradeToFederatedLogin": True or False, # Mark the user to upgrade to federated login. "disableUser": True or False, # Whether to disable the user. "captchaChallenge": "A String", # The captcha challenge. "idToken": "A String", # The GITKit token of the authenticated user. @@ -380,8 +428,6 @@

Method Details

{ # Respone of setting the account information. "kind": "identitytoolkit#SetAccountInfoResponse", # The fixed string "identitytoolkit#SetAccountInfoResponse". "displayName": "A String", # The name of the user. - "newEmail": "A String", # The new email the user attempts to change to. - "idToken": "A String", # The Gitkit id token to login the newly sign up user. "providerUserInfo": [ # The user's profiles at the associated IdPs. { "providerId": "A String", # The IdP ID. For whitelisted 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. @@ -389,6 +435,61 @@

Method Details

"photoUrl": "A String", # The user's photo url at the IDP. }, ], + "photoUrl": "A String", # The photo url of the user. + "idToken": "A String", # The Gitkit id token to login the newly sign up user. + "newEmail": "A String", # The new email the user attempts to change to. + "email": "A String", # The email of the user. + }
+
+ +
+ signOutUser(body) +
Sign out user.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Request to sign out user.
+    "instanceId": "A String", # Instance id token of the app.
+    "localId": "A String", # The local ID of the user.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Response of signing out user.
+    "localId": "A String", # The local ID of the user.
+  }
+
+ +
+ signupNewUser(body) +
Signup new user.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Request to signup new user, create anonymous user or anonymous user reauth.
+    "instanceId": "A String", # Instance id token of the app.
+    "displayName": "A String", # The name of the user.
+    "captchaResponse": "A String", # Response to the captcha.
+    "idToken": "A String", # The GITKit token of the authenticated user.
+    "captchaChallenge": "A String", # The captcha challenge.
+    "password": "A String", # The new password of the user.
+    "email": "A String", # The email of the user.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Response of signing up new user, creating anonymous user or anonymous user reauth.
+    "idToken": "A String", # The Gitkit id token to login the newly sign up user.
+    "kind": "identitytoolkit#SignupNewUserResponse", # The fixed string "identitytoolkit#SignupNewUserResponse".
+    "displayName": "A String", # The name of the user.
     "email": "A String", # The email of the user.
   }
@@ -403,6 +504,7 @@

Method Details

{ # Request to upload user account in batch. "hashAlgorithm": "A String", # The password hash algorithm. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. "users": [ # The account info to be stored. { # Template for an individual account info. "displayName": "A String", # The name of the user. @@ -418,6 +520,7 @@

Method Details

"federatedId": "A String", # User's identifier at IDP. "providerId": "A String", # 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. "displayName": "A String", # The user's display name at the IDP. + "email": "A String", # User's email at IDP. "photoUrl": "A String", # The user's photo url at the IDP. }, ], @@ -456,10 +559,14 @@

Method Details

The object takes the form of: { # Request to verify the IDP assertion. - "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP. "postBody": "A String", # The post body if the request is a HTTP POST. - "returnRefreshToken": True or False, # Whether to return refresh tokens. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. + "instanceId": "A String", # Instance id token of the app. + "idToken": "A String", # The GITKit token of the authenticated user. "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP pending to be confirmed by the user. + "sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request. + "requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP. + "returnRefreshToken": True or False, # Whether to return refresh tokens. } @@ -475,7 +582,7 @@

Method Details

"verifiedProvider": [ # When action is 'map', contains the idps which can be used for confirmation. "A String", ], - "providerId": "A String", # 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. + "needEmail": True or False, # Whether need client to supply email to complete the federated login flow. "dateOfBirth": "A String", # The birth date of the IdP account. "nickName": "A String", # The nick name of the user. "email": "A String", # The email returned by the IdP. NOTE: The federated login user may not own the email. @@ -494,6 +601,7 @@

Method Details

"oauthRequestToken": "A String", # The user approved request token for the OpenID OAuth extension. "oauthAuthorizationCode": "A String", # The OAuth2 authorization code. "originalEmail": "A String", # The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email. + "providerId": "A String", # 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. "context": "A String", # The opaque value used by the client to maintain context info between the authentication request and the IDP callback. "lastName": "A String", # The last name of the user. "action": "A String", # The action code. @@ -502,6 +610,29 @@

Method Details

}
+
+ verifyCustomToken(body) +
Verifies the developer asserted ID token.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Request to verify a custom token
+    "instanceId": "A String", # Instance id token of the app.
+    "token": "A String", # The custom token to verify
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # Response from verifying a custom token
+    "idToken": "A String", # The GITKit token for authenticated user.
+    "kind": "identitytoolkit#VerifyCustomTokenResponse", # The fixed string "identitytoolkit#VerifyCustomTokenResponse".
+  }
+
+
verifyPassword(body)
Verifies the user entered password.
@@ -511,11 +642,14 @@ 

Method Details

The object takes the form of: { # Request to verify the password. + "instanceId": "A String", # Instance id token of the app. + "delegatedProjectNumber": "A String", # GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. "captchaResponse": "A String", # Response to the captcha. + "idToken": "A String", # The GITKit token of the authenticated user. + "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user. "captchaChallenge": "A String", # The captcha challenge. "password": "A String", # The password inputed by the user. "email": "A String", # The email of the user. - "pendingIdToken": "A String", # The GITKit token for the non-trusted IDP, which is to be confirmed by the user. } diff --git a/docs/dyn/kgsearch_v1.entities.html b/docs/dyn/kgsearch_v1.entities.html new file mode 100644 index 00000000000..c413be923b4 --- /dev/null +++ b/docs/dyn/kgsearch_v1.entities.html @@ -0,0 +1,107 @@ + + + +

Knowledge Graph Search API . entities

+

Instance Methods

+

+ search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None)

+

Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

+

Method Details

+
+ search(prefix=None, query=None, x__xgafv=None, types=None, indent=None, languages=None, ids=None, limit=None) +
Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org
+
+Args:
+  prefix: boolean, Enables prefix match against names and aliases of entities
+  query: string, The literal query string for search.
+  x__xgafv: string, V1 error format.
+  types: string, Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). (repeated)
+  indent: boolean, Enables indenting of json results.
+  languages: string, The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. (repeated)
+  ids: string, The list of entity id to be used for search instead of query string. (repeated)
+  limit: integer, Limits the number of entities to be returned.
+
+Returns:
+  An object of the form:
+
+    { # Response message includes the context and a list of matching results which contain the detail of associated entities.
+    "itemListElement": [ # The item list of search results.
+      "",
+    ],
+    "type": "", # The schema type of top-level JSON-LD object, e.g. ItemList.
+    "context": "", # The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/kgsearch_v1.html b/docs/dyn/kgsearch_v1.html new file mode 100644 index 00000000000..df53eee1df4 --- /dev/null +++ b/docs/dyn/kgsearch_v1.html @@ -0,0 +1,103 @@ + + + +

Knowledge Graph Search API

+

Instance Methods

+

+ entities() +

+

Returns the entities Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.entries.html b/docs/dyn/logging_v2beta1.entries.html new file mode 100644 index 00000000000..4ac177d39b6 --- /dev/null +++ b/docs/dyn/logging_v2beta1.entries.html @@ -0,0 +1,226 @@ + + + +

Google Cloud Logging API . entries

+

Instance Methods

+

+ list(body, x__xgafv=None)

+

Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).

+

+ write(body, x__xgafv=None)

+

Writes log entries to Cloud Logging. All log entries in Cloud Logging are written by this method.

+

Method Details

+
+ list(body, x__xgafv=None) +
Lists log entries. Use this method to retrieve log entries from Cloud Logging. For ways to export log entries, see [Exporting Logs](/logging/docs/export).
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The parameters to `ListLogEntries`.
+    "filter": "A String", # Optional. An [advanced logs filter](/logging/docs/view/advanced_filters). The filter is compared against all log entries in the projects specified by `projectIds`. Only entries that match the filter are retrieved. An empty filter matches all log entries.
+    "projectIds": [ # Required. One or more project IDs or project numbers from which to retrieve log entries. Examples of a project ID: `"my-project-1A"`, `"1234567890"`.
+      "A String",
+    ],
+    "pageSize": 42, # 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.
+    "orderBy": "A String", # 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`.
+    "pageToken": "A String", # 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.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Result returned from `ListLogEntries`.
+    "nextPageToken": "A String", # 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`.
+    "entries": [ # A list of log entries.
+      { # An individual entry in a log.
+        "httpRequest": { # A common proto for logging HTTP requests. # Optional. Information about the HTTP request associated with this log entry, if applicable.
+          "status": 42, # The response code indicating the status of response. Examples: 200, 404.
+          "cacheHit": True or False, # Whether or not an entity was served from cache (with or without validation).
+          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`.
+          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
+          "referer": "A String", # The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+          "validatedWithOriginServer": True or False, # 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.
+          "userAgent": "A String", # The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request headers and the request body.
+          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
+        },
+        "resource": { # A specific monitored resource or a group of monitored resources. # Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
+          "labels": { # 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.
+            "a_key": "A String",
+          },
+          "type": "A String", # 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.
+        },
+        "severity": "A String", # Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
+        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+        "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
+        "labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
+          "a_key": "A String",
+        },
+        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
+        "jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
+          "a_key": "", # Properties of the object.
+        },
+        "logName": "A String", # Required. The resource name of the log to which this log entry belongs. The format of the name is `projects//logs/
+
+ +
+ write(body, x__xgafv=None) +
Writes log entries to Cloud Logging. All log entries in Cloud Logging are written by this method.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # The parameters to WriteLogEntries.
+    "resource": { # A specific monitored resource or a group of monitored resources. # Optional. A default monitored resource for those log entries in `entries` that do not specify their own `resource`.
+      "labels": { # 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.
+        "a_key": "A String",
+      },
+      "type": "A String", # 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.
+    },
+    "labels": { # Optional. User-defined `key:value` items that are added to the `labels` field of each log entry in `entries`, except when a log entry specifies its own `key:value` item with the same key. Example: `{ "size": "large", "color":"red" }`
+      "a_key": "A String",
+    },
+    "logName": "A String", # Optional. A default log resource name for those log entries in `entries` that do not specify their own `logName`. Example: `"projects/my-project/logs/syslog"`. See LogEntry.
+    "entries": [ # Required. The log entries to write. The log entries must have values for all required fields.
+      { # An individual entry in a log.
+        "httpRequest": { # A common proto for logging HTTP requests. # Optional. Information about the HTTP request associated with this log entry, if applicable.
+          "status": 42, # The response code indicating the status of response. Examples: 200, 404.
+          "cacheHit": True or False, # Whether or not an entity was served from cache (with or without validation).
+          "requestUrl": "A String", # The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`.
+          "requestMethod": "A String", # The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`.
+          "referer": "A String", # The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
+          "remoteIp": "A String", # The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`.
+          "validatedWithOriginServer": True or False, # 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.
+          "userAgent": "A String", # The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`.
+          "requestSize": "A String", # The size of the HTTP request message in bytes, including the request headers and the request body.
+          "responseSize": "A String", # The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
+        },
+        "resource": { # A specific monitored resource or a group of monitored resources. # Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.
+          "labels": { # 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.
+            "a_key": "A String",
+          },
+          "type": "A String", # 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.
+        },
+        "severity": "A String", # Optional. The severity of the log entry. The default value is `LogSeverity.DEFAULT`.
+        "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+        "timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted, Cloud Logging will use the time the log entry is written.
+        "labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
+          "a_key": "A String",
+        },
+        "insertId": "A String", # Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Cloud Logging will generate a unique ID for this log entry.
+        "jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
+          "a_key": "", # Properties of the object.
+        },
+        "logName": "A String", # Required. The resource name of the log to which this log entry belongs. The format of the name is `projects//logs/
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.html b/docs/dyn/logging_v2beta1.html new file mode 100644 index 00000000000..d83602070c7 --- /dev/null +++ b/docs/dyn/logging_v2beta1.html @@ -0,0 +1,113 @@ + + + +

Google Cloud Logging API

+

Instance Methods

+

+ entries() +

+

Returns the entries Resource.

+ +

+ monitoredResourceDescriptors() +

+

Returns the monitoredResourceDescriptors Resource.

+ +

+ projects() +

+

Returns the projects Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html b/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html new file mode 100644 index 00000000000..7211cefa517 --- /dev/null +++ b/docs/dyn/logging_v2beta1.monitoredResourceDescriptors.html @@ -0,0 +1,129 @@ + + + +

Google Cloud Logging API . monitoredResourceDescriptors

+

Instance Methods

+

+ list(pageSize=None, pageToken=None, x__xgafv=None)

+

Lists monitored resource descriptors that are used by Cloud Logging.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ list(pageSize=None, pageToken=None, x__xgafv=None) +
Lists monitored resource descriptors that are used by Cloud Logging.
+
+Args:
+  pageSize: integer, 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.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Result returned from ListMonitoredResourceDescriptors.
+    "nextPageToken": "A String", # 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`.
+    "resourceDescriptors": [ # A list of resource descriptors.
+      { # A description of a type of monitored resource.
+        "displayName": "A String", # A concise name for the monitored resource type, which is displayed in user interfaces. For example, `"Cloud SQL Database"`.
+        "labels": [ # 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"`.
+          { # A description of a label.
+            "valueType": "A String", # The type of data that can be assigned to the label.
+            "description": "A String", # A human-readable description for the label.
+            "key": "A String", # The label key.
+          },
+        ],
+        "type": "A String", # The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL.
+        "description": "A String", # A detailed description of the monitored resource type, which is used in documentation.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.projects.html b/docs/dyn/logging_v2beta1.projects.html new file mode 100644 index 00000000000..24241c7b2e5 --- /dev/null +++ b/docs/dyn/logging_v2beta1.projects.html @@ -0,0 +1,92 @@ + + + +

Google Cloud Logging API . projects

+

Instance Methods

+

+ logs() +

+

Returns the logs Resource.

+ +

+ metrics() +

+

Returns the metrics Resource.

+ +

+ sinks() +

+

Returns the sinks Resource.

+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.projects.logs.html b/docs/dyn/logging_v2beta1.projects.logs.html new file mode 100644 index 00000000000..babc136138a --- /dev/null +++ b/docs/dyn/logging_v2beta1.projects.logs.html @@ -0,0 +1,96 @@ + + + +

Google Cloud Logging API . projects . logs

+

Instance Methods

+

+ delete(logName, x__xgafv=None)

+

Deletes a log and all its log entries. The log will reappear if it receives new entries.

+

Method Details

+
+ delete(logName, x__xgafv=None) +
Deletes a log and all its log entries. The log will reappear if it receives new entries.
+
+Args:
+  logName: string, Required. The resource name of the log to delete. Example: `"projects/my-project/logs/syslog"`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.projects.metrics.html b/docs/dyn/logging_v2beta1.projects.metrics.html new file mode 100644 index 00000000000..5884077642a --- /dev/null +++ b/docs/dyn/logging_v2beta1.projects.metrics.html @@ -0,0 +1,222 @@ + + + +

Google Cloud Logging API . projects . metrics

+

Instance Methods

+

+ create(projectName, body, x__xgafv=None)

+

Creates a logs-based metric.

+

+ delete(metricName, x__xgafv=None)

+

Deletes a logs-based metric.

+

+ get(metricName, x__xgafv=None)

+

Gets a logs-based metric.

+

+ list(projectName, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists logs-based metrics.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ update(metricName, body, x__xgafv=None)

+

Creates or updates a logs-based metric.

+

Method Details

+
+ create(projectName, body, x__xgafv=None) +
Creates a logs-based metric.
+
+Args:
+  projectName: string, The resource name of the project in which to create the metric. Example: `"projects/my-project-id"`. The new metric must be provided in the request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+    "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+    "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+    "description": "A String", # A description of this metric, which is used in documentation.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+      "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+      "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+      "description": "A String", # A description of this metric, which is used in documentation.
+    }
+
+ +
+ delete(metricName, x__xgafv=None) +
Deletes a logs-based metric.
+
+Args:
+  metricName: string, The resource name of the metric to delete. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(metricName, x__xgafv=None) +
Gets a logs-based metric.
+
+Args:
+  metricName: string, The resource name of the desired metric. Example: `"projects/my-project-id/metrics/my-metric-id"`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+      "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+      "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+      "description": "A String", # A description of this metric, which is used in documentation.
+    }
+
+ +
+ list(projectName, pageSize=None, pageToken=None, x__xgafv=None) +
Lists logs-based metrics.
+
+Args:
+  projectName: string, Required. The resource name of the project containing the metrics. Example: `"projects/my-project-id"`. (required)
+  pageSize: integer, 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.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Result returned from ListLogMetrics.
+    "metrics": [ # A list of logs-based metrics.
+      { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+          "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+          "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+          "description": "A String", # A description of this metric, which is used in documentation.
+        },
+    ],
+    "nextPageToken": "A String", # 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`.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ update(metricName, body, x__xgafv=None) +
Creates or updates a logs-based metric.
+
+Args:
+  metricName: string, The resource name of the metric to update. Example: `"projects/my-project-id/metrics/my-metric-id"`. The updated metric must be provided in the request and have the same identifier that is specified in `metricName`. If the metric does not exist, it is created. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+    "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+    "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+    "description": "A String", # A description of this metric, which is used in documentation.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter.
+      "filter": "A String", # An [advanced logs filter](/logging/docs/view/advanced_filters). Example: `"logName:syslog AND severity>=ERROR"`.
+      "name": "A String", # Required. The client-assigned metric identifier. Example: `"severe_errors"`. Metric identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.,+!*',()%/\`. The forward-slash character (`/`) denotes a hierarchy of name pieces, and it cannot be the first character of the name.
+      "description": "A String", # A description of this metric, which is used in documentation.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/logging_v2beta1.projects.sinks.html b/docs/dyn/logging_v2beta1.projects.sinks.html new file mode 100644 index 00000000000..4de17044f09 --- /dev/null +++ b/docs/dyn/logging_v2beta1.projects.sinks.html @@ -0,0 +1,228 @@ + + + +

Google Cloud Logging API . projects . sinks

+

Instance Methods

+

+ create(projectName, body, x__xgafv=None)

+

Creates a sink.

+

+ delete(sinkName, x__xgafv=None)

+

Deletes a sink.

+

+ get(sinkName, x__xgafv=None)

+

Gets a sink.

+

+ list(projectName, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists sinks.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ update(sinkName, body, x__xgafv=None)

+

Creates or updates a sink.

+

Method Details

+
+ create(projectName, body, x__xgafv=None) +
Creates a sink.
+
+Args:
+  projectName: string, The resource name of the project in which to create the sink. Example: `"projects/my-project-id"`. The new sink must be provided in the request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes a sink used to export log entries outside Cloud Logging.
+    "filter": "A String", # 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>=ERROR"`.
+    "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+    "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+    "outputVersionFormat": "A String", # 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.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a sink used to export log entries outside Cloud Logging.
+      "filter": "A String", # 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>=ERROR"`.
+      "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+      "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+      "outputVersionFormat": "A String", # 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.
+    }
+
+ +
+ delete(sinkName, x__xgafv=None) +
Deletes a sink.
+
+Args:
+  sinkName: string, The resource name of the sink to delete. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(sinkName, x__xgafv=None) +
Gets a sink.
+
+Args:
+  sinkName: string, The resource name of the sink to return. Example: `"projects/my-project-id/sinks/my-sink-id"`. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a sink used to export log entries outside Cloud Logging.
+      "filter": "A String", # 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>=ERROR"`.
+      "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+      "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+      "outputVersionFormat": "A String", # 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.
+    }
+
+ +
+ list(projectName, pageSize=None, pageToken=None, x__xgafv=None) +
Lists sinks.
+
+Args:
+  projectName: string, Required. The resource name of the project containing the sinks. Example: `"projects/my-logging-project"`, `"projects/01234567890"`. (required)
+  pageSize: integer, 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.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Result returned from `ListSinks`.
+    "nextPageToken": "A String", # 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`.
+    "sinks": [ # A list of sinks.
+      { # Describes a sink used to export log entries outside Cloud Logging.
+          "filter": "A String", # 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>=ERROR"`.
+          "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+          "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+          "outputVersionFormat": "A String", # 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.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ update(sinkName, body, x__xgafv=None) +
Creates or updates a sink.
+
+Args:
+  sinkName: string, The resource name of the sink to update. Example: `"projects/my-project-id/sinks/my-sink-id"`. The updated sink must be provided in the request and have the same name that is specified in `sinkName`. If the sink does not exist, it is created. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Describes a sink used to export log entries outside Cloud Logging.
+    "filter": "A String", # 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>=ERROR"`.
+    "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+    "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+    "outputVersionFormat": "A String", # 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.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Describes a sink used to export log entries outside Cloud Logging.
+      "filter": "A String", # 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>=ERROR"`.
+      "destination": "A String", # The export destination. See [Exporting Logs With Sinks](/logging/docs/api/tasks/exporting-logs). Examples: `"storage.googleapis.com/a-bucket"`, `"bigquery.googleapis.com/projects/a-project-id/datasets/a-dataset"`.
+      "name": "A String", # Required. The client-assigned sink identifier. Example: `"my-severe-errors-to-pubsub"`. Sink identifiers are limited to 1000 characters and can include only the following characters: `A-Z`, `a-z`, `0-9`, and the special characters `_-.`.
+      "outputVersionFormat": "A String", # 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.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/partners_v2.clientMessages.html b/docs/dyn/partners_v2.clientMessages.html index b27253ad2bc..983a759491b 100644 --- a/docs/dyn/partners_v2.clientMessages.html +++ b/docs/dyn/partners_v2.clientMessages.html @@ -86,7 +86,7 @@

Method Details

body: object, The request body. (required) The object takes the form of: -{ # Request message for [LogClientMessage][google.partners.v2.ClientAuditor.LogClientMessage]. +{ # Request message for LogClientMessage. "clientInfo": { # Map of client info, such as URL, browser navigator, browser platform, etc. "a_key": "A String", }, @@ -114,7 +114,7 @@

Method Details

Returns: An object of the form: - { # Response message for [LogClientMessage][google.partners.v2.ClientAuditor.LogClientMessage]. + { # Response message for LogClientMessage. "responseMetadata": { # Common data that is in each API response. # Current response metadata. "debugInfo": { # Debug information about this request. # Debug information about this request. "serverTraceInfo": "A String", # Server-side debug stack trace. diff --git a/docs/dyn/partners_v2.companies.html b/docs/dyn/partners_v2.companies.html index 533d90d0829..38f4bc4522b 100644 --- a/docs/dyn/partners_v2.companies.html +++ b/docs/dyn/partners_v2.companies.html @@ -111,7 +111,7 @@

Method Details

Returns: An object of the form: - { # Response message for [GetCompany][google.partners.v2.Partner.GetCompany]. + { # Response message for GetCompany. "company": { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers. # The company. "industries": [ # Industries the company can help with. "A String", @@ -202,7 +202,7 @@

Method Details

x__xgafv: string, V1 error format. industries: string, List of industries the company can help with. (repeated) requestMetadata_locale: string, Locale to use for the current request. - pageToken: string, A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to [ListCompanies][google.partners.v2.Partner.ListCompanies]. + pageToken: string, A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies. minMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217. companyName: string, Company name to search for. maxMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -220,8 +220,8 @@

Method Details

Returns: An object of the form: - { # Response message for [ListCompanies][google.partners.v2.Partner.ListCompanies]. - "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to [ListCompanies][google.partners.v2.Partner.ListCompanies] to retrieve the next page of results. + { # Response message for ListCompanies. + "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to ListCompanies to retrieve the next page of results. "companies": [ # The list of companies. { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers. "industries": [ # Industries the company can help with. diff --git a/docs/dyn/partners_v2.companies.leads.html b/docs/dyn/partners_v2.companies.leads.html index 4478798b0a4..021e490fb8f 100644 --- a/docs/dyn/partners_v2.companies.leads.html +++ b/docs/dyn/partners_v2.companies.leads.html @@ -87,7 +87,7 @@

Method Details

body: object, The request body. (required) The object takes the form of: -{ # Request message for [CreateLead][google.partners.v2.Partner.CreateLead]. +{ # Request message for CreateLead. "requestMetadata": { # Common data that is in each API request. # Current request metadata. "locale": "A String", # Locale to use for the current request. "partnersSessionId": "A String", # Google Partners session ID. @@ -132,7 +132,7 @@

Method Details

Returns: An object of the form: - { # Response message for [CreateLead][google.partners.v2.Partner.CreateLead]. Debug information about this request. + { # Response message for CreateLead. Debug information about this request. "recaptchaStatus": "A String", # The outcome of reCaptcha validation. "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Lead that was created depending on the outcome of reCaptcha validation. "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. diff --git a/docs/dyn/partners_v2.userEvents.html b/docs/dyn/partners_v2.userEvents.html index 99ff4153807..1ac934a1df7 100644 --- a/docs/dyn/partners_v2.userEvents.html +++ b/docs/dyn/partners_v2.userEvents.html @@ -86,7 +86,7 @@

Method Details

body: object, The request body. (required) The object takes the form of: -{ # Request message for [LogUserEvent][google.partners.v2.ClientAuditor.LogUserEvent]. +{ # Request message for LogUserEvent. "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Advertiser lead information. "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. "A String", @@ -139,7 +139,7 @@

Method Details

Returns: An object of the form: - { # Response message for [LogUserEvent][google.partners.v2.ClientAuditor.LogUserEvent]. + { # Response message for LogUserEvent. "responseMetadata": { # Common data that is in each API response. # Current response metadata. "debugInfo": { # Debug information about this request. # Debug information about this request. "serverTraceInfo": "A String", # Server-side debug stack trace. diff --git a/docs/dyn/partners_v2.userStates.html b/docs/dyn/partners_v2.userStates.html index d0fdac43563..dff44e6160f 100644 --- a/docs/dyn/partners_v2.userStates.html +++ b/docs/dyn/partners_v2.userStates.html @@ -95,7 +95,7 @@

Method Details

Returns: An object of the form: - { # Response message for [ListUserStates][google.partners.v2.ClientAuditor.ListUserStates]. + { # Response message for ListUserStates. "userStates": [ # User's states. "A String", ], diff --git a/docs/dyn/people_v1.html b/docs/dyn/people_v1.html new file mode 100644 index 00000000000..6c147a16133 --- /dev/null +++ b/docs/dyn/people_v1.html @@ -0,0 +1,103 @@ + + + +

Google People API

+

Instance Methods

+

+ people() +

+

Returns the people Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/people_v1.people.connections.html b/docs/dyn/people_v1.people.connections.html new file mode 100644 index 00000000000..80d8d817cb8 --- /dev/null +++ b/docs/dyn/people_v1.people.connections.html @@ -0,0 +1,540 @@ + + + +

Google People API . people . connections

+

Instance Methods

+

+ list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, syncToken=None, requestMask_includeField=None)

+

Provides a list of the authenticated user's contacts merged with any linked profiles.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, syncToken=None, requestMask_includeField=None) +
Provides a list of the authenticated user's contacts merged with any linked profiles.
+
+Args:
+  resourceName: string, The resource name to return connections for. Only `people/me` is valid. (required)
+  pageSize: integer, The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100.
+  x__xgafv: string, V1 error format.
+  pageToken: string, The token of the page to be returned.
+  sortOrder: string, The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
+  syncToken: string, A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created are returned.
+  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
+
+Returns:
+  An object of the form:
+
+    {
+    "connections": [ # The list of people that the requestor is connected to.
+      { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
+        "phoneNumbers": [ # The person's phone numbers.
+          { # A person's phone number.
+            "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+            "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
+            "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+            "value": "A String", # The phone number.
+            "metadata": { # Metadata about a field. # Metadata about the phone number.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "addresses": [ # The person's street addresses.
+          { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+            "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+            "city": "A String", # The city of the address.
+            "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "region": "A String", # The region of the address; for example, the state or province.
+            "poBox": "A String", # The P.O. box of the address.
+            "streetAddress": "A String", # The street address.
+            "country": "A String", # The country of the address.
+            "postalCode": "A String", # The postal code of the address.
+            "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+            "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+            "metadata": { # Metadata about a field. # Metadata about the address.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "nicknames": [ # The person's nicknames.
+          { # A person's nickname.
+            "type": "A String", # The type of the nickname.
+            "value": "A String", # The nickname.
+            "metadata": { # Metadata about a field. # Metadata about the nickname.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "occupations": [ # The person's occupations.
+          { # A person's occupation.
+            "value": "A String", # The occupation; for example, `carpenter`.
+            "metadata": { # Metadata about a field. # Metadata about the occupation.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "braggingRights": [ # The person's bragging rights.
+          { # A person's bragging rights.
+            "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+            "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "names": [ # The person's names.
+          { # A person's name. If the name is a mononym, the family name is empty.
+            "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+            "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+            "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+            "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
+            "middleName": "A String", # The middle name(s).
+            "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+            "familyName": "A String", # The family name.
+            "phoneticGivenName": "A String", # The given name spelled as it sounds.
+            "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+            "givenName": "A String", # The given name.
+            "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+            "metadata": { # Metadata about a field. # Metadata about the name.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
+        "birthdays": [ # The person's birthdays.
+          { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
+            "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
+              "month": 42, # Month of year. Must be from 1 to 12.
+              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+            },
+            "text": "A String", # A free-form string representing the user's birthday.
+            "metadata": { # Metadata about a field. # Metadata about the birthday.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "relations": [ # The person's relations.
+          { # A person's relation to another person.
+            "person": "A String", # The name of the other person this relation refers to.
+            "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+            "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+            "metadata": { # Metadata about a field. # Metadata about the relation.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
+        "relationshipStatuses": [ # The person's relationship statuses.
+          { # A person's relationship status.
+            "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+            "metadata": { # Metadata about a field. # Metadata about the relationship status.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "skills": [ # The person's skills.
+          { # A skill that the person has.
+            "value": "A String", # The skill; for example, `underwater basket weaving`.
+            "metadata": { # Metadata about a field. # Metadata about the skill.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "imClients": [ # The person's instant messaging clients.
+          { # A person's instant messaging client.
+            "username": "A String", # The user name used in the IM client.
+            "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+            "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+            "metadata": { # Metadata about a field. # Metadata about the IM client.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "events": [ # The person's events.
+          { # An event related to the person.
+            "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
+              "month": 42, # Month of year. Must be from 1 to 12.
+              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+            },
+            "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
+            "metadata": { # Metadata about a field. # Metadata about the event.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "metadata": { # Metadata about a person. # Metadata about the person.
+          "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+            "A String",
+          ],
+          "sources": [ # The sources of data for the person.
+            { # The source of a field.
+              "type": "A String", # The source type.
+              "id": "A String", # A unique identifier within the source type generated by the server.
+            },
+          ],
+          "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+          "objectType": "A String", # The type of the person object.
+        },
+        "interests": [ # The person's interests.
+          { # One of the person's interests.
+            "value": "A String", # The interest; for example, `stargazing`.
+            "metadata": { # Metadata about a field. # Metadata about the interest.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "photos": [ # The person's photos.
+          { # A person's photo. A picture shown next to the person's name to help others recognize the person.
+            "url": "A String", # The URL of the photo.
+            "metadata": { # Metadata about a field. # Metadata about the photo.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "residences": [ # The person's residences.
+          { # A person's past or current residence.
+            "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+            "value": "A String", # The address of the residence.
+            "metadata": { # Metadata about a field. # Metadata about the residence.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "relationshipInterests": [ # The kind of relationship the person is looking for.
+          { # The kind of relationship the person is looking for.
+            "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+            "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
+            "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "coverPhotos": [ # The person's cover photos.
+          { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
+            "url": "A String", # The URL of the cover photo.
+            "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
+            "metadata": { # Metadata about a field. # Metadata about the cover photo.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "locales": [ # The person's locale preferences.
+          { # A person's locale preference.
+            "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+            "metadata": { # Metadata about a field. # Metadata about the locale.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "organizations": [ # The person's past or current organizations.
+          { # A person's past or current organization. Overlapping date ranges are permitted.
+            "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+            "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
+              "month": 42, # Month of year. Must be from 1 to 12.
+              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+            },
+            "name": "A String", # The name of the organization.
+            "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
+              "month": 42, # Month of year. Must be from 1 to 12.
+              "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+              "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+            },
+            "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+            "title": "A String", # The person's job title at the organization.
+            "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+            "jobDescription": "A String", # The person's job description at the organization.
+            "location": "A String", # The location of the organization office the person works at.
+            "department": "A String", # The person's department at the organization.
+            "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
+            "phoneticName": "A String", # The phonetic name of the organization.
+            "metadata": { # Metadata about a field. # Metadata about the organization.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "biographies": [ # The person's biographies.
+          { # A person's short biography.
+            "value": "A String", # The short biography.
+            "metadata": { # Metadata about a field. # Metadata about the biography.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "memberships": [ # The person's group memberships.
+          { # A person's membership in a group.
+            "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+              "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
+            },
+            "domainMembership": { # A Google Apps Domain membership. # The domain membership.
+              "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
+            },
+            "metadata": { # Metadata about a field. # Metadata about the membership.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "taglines": [ # The person's taglines.
+          { # A brief one-line description of the person.
+            "value": "A String", # The tagline.
+            "metadata": { # Metadata about a field. # Metadata about the tagline.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "urls": [ # The person's associated URLs.
+          { # A person's associated URLs.
+            "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
+            "value": "A String", # The URL.
+            "metadata": { # Metadata about a field. # Metadata about the URL.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "ageRange": "A String", # The person's age range.
+        "genders": [ # The person's genders.
+          { # A person's gender.
+            "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
+            "metadata": { # Metadata about a field. # Metadata about the gender.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+        "emailAddresses": [ # The person's email addresses.
+          { # A person's email address.
+            "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+            "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+            "value": "A String", # The email address.
+            "metadata": { # Metadata about a field. # Metadata about the email address.
+              "source": { # The source of a field. # The source of the field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+              "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+              "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+            },
+          },
+        ],
+      },
+    ],
+    "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
+    "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html new file mode 100644 index 00000000000..4ed3fa25bd7 --- /dev/null +++ b/docs/dyn/people_v1.people.html @@ -0,0 +1,961 @@ + + + +

Google People API . people

+

Instance Methods

+

+ connections() +

+

Returns the connections Resource.

+ +

+ get(resourceName, x__xgafv=None, requestMask_includeField=None)

+

Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.

+

+ getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)

+

Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.

+

Method Details

+
+ get(resourceName, x__xgafv=None, requestMask_includeField=None) +
Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.
+
+Args:
+  resourceName: string, The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
+  x__xgafv: string, V1 error format.
+  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
+
+Returns:
+  An object of the form:
+
+    { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
+    "phoneNumbers": [ # The person's phone numbers.
+      { # A person's phone number.
+        "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+        "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
+        "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+        "value": "A String", # The phone number.
+        "metadata": { # Metadata about a field. # Metadata about the phone number.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "addresses": [ # The person's street addresses.
+      { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+        "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+        "city": "A String", # The city of the address.
+        "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "region": "A String", # The region of the address; for example, the state or province.
+        "poBox": "A String", # The P.O. box of the address.
+        "streetAddress": "A String", # The street address.
+        "country": "A String", # The country of the address.
+        "postalCode": "A String", # The postal code of the address.
+        "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+        "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+        "metadata": { # Metadata about a field. # Metadata about the address.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "nicknames": [ # The person's nicknames.
+      { # A person's nickname.
+        "type": "A String", # The type of the nickname.
+        "value": "A String", # The nickname.
+        "metadata": { # Metadata about a field. # Metadata about the nickname.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "occupations": [ # The person's occupations.
+      { # A person's occupation.
+        "value": "A String", # The occupation; for example, `carpenter`.
+        "metadata": { # Metadata about a field. # Metadata about the occupation.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "braggingRights": [ # The person's bragging rights.
+      { # A person's bragging rights.
+        "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+        "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "names": [ # The person's names.
+      { # A person's name. If the name is a mononym, the family name is empty.
+        "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+        "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+        "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+        "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
+        "middleName": "A String", # The middle name(s).
+        "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+        "familyName": "A String", # The family name.
+        "phoneticGivenName": "A String", # The given name spelled as it sounds.
+        "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+        "givenName": "A String", # The given name.
+        "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+        "metadata": { # Metadata about a field. # Metadata about the name.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
+    "birthdays": [ # The person's birthdays.
+      { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
+        "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
+          "month": 42, # Month of year. Must be from 1 to 12.
+          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        },
+        "text": "A String", # A free-form string representing the user's birthday.
+        "metadata": { # Metadata about a field. # Metadata about the birthday.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "relations": [ # The person's relations.
+      { # A person's relation to another person.
+        "person": "A String", # The name of the other person this relation refers to.
+        "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+        "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+        "metadata": { # Metadata about a field. # Metadata about the relation.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
+    "relationshipStatuses": [ # The person's relationship statuses.
+      { # A person's relationship status.
+        "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+        "metadata": { # Metadata about a field. # Metadata about the relationship status.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "skills": [ # The person's skills.
+      { # A skill that the person has.
+        "value": "A String", # The skill; for example, `underwater basket weaving`.
+        "metadata": { # Metadata about a field. # Metadata about the skill.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "imClients": [ # The person's instant messaging clients.
+      { # A person's instant messaging client.
+        "username": "A String", # The user name used in the IM client.
+        "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+        "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+        "metadata": { # Metadata about a field. # Metadata about the IM client.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "events": [ # The person's events.
+      { # An event related to the person.
+        "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
+          "month": 42, # Month of year. Must be from 1 to 12.
+          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        },
+        "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
+        "metadata": { # Metadata about a field. # Metadata about the event.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "metadata": { # Metadata about a person. # Metadata about the person.
+      "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+        "A String",
+      ],
+      "sources": [ # The sources of data for the person.
+        { # The source of a field.
+          "type": "A String", # The source type.
+          "id": "A String", # A unique identifier within the source type generated by the server.
+        },
+      ],
+      "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+      "objectType": "A String", # The type of the person object.
+    },
+    "interests": [ # The person's interests.
+      { # One of the person's interests.
+        "value": "A String", # The interest; for example, `stargazing`.
+        "metadata": { # Metadata about a field. # Metadata about the interest.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "photos": [ # The person's photos.
+      { # A person's photo. A picture shown next to the person's name to help others recognize the person.
+        "url": "A String", # The URL of the photo.
+        "metadata": { # Metadata about a field. # Metadata about the photo.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "residences": [ # The person's residences.
+      { # A person's past or current residence.
+        "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+        "value": "A String", # The address of the residence.
+        "metadata": { # Metadata about a field. # Metadata about the residence.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "relationshipInterests": [ # The kind of relationship the person is looking for.
+      { # The kind of relationship the person is looking for.
+        "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+        "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
+        "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "coverPhotos": [ # The person's cover photos.
+      { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
+        "url": "A String", # The URL of the cover photo.
+        "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
+        "metadata": { # Metadata about a field. # Metadata about the cover photo.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "locales": [ # The person's locale preferences.
+      { # A person's locale preference.
+        "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+        "metadata": { # Metadata about a field. # Metadata about the locale.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "organizations": [ # The person's past or current organizations.
+      { # A person's past or current organization. Overlapping date ranges are permitted.
+        "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+        "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
+          "month": 42, # Month of year. Must be from 1 to 12.
+          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        },
+        "name": "A String", # The name of the organization.
+        "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
+          "month": 42, # Month of year. Must be from 1 to 12.
+          "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+          "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+        },
+        "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+        "title": "A String", # The person's job title at the organization.
+        "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+        "jobDescription": "A String", # The person's job description at the organization.
+        "location": "A String", # The location of the organization office the person works at.
+        "department": "A String", # The person's department at the organization.
+        "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
+        "phoneticName": "A String", # The phonetic name of the organization.
+        "metadata": { # Metadata about a field. # Metadata about the organization.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "biographies": [ # The person's biographies.
+      { # A person's short biography.
+        "value": "A String", # The short biography.
+        "metadata": { # Metadata about a field. # Metadata about the biography.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "memberships": [ # The person's group memberships.
+      { # A person's membership in a group.
+        "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+          "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
+        },
+        "domainMembership": { # A Google Apps Domain membership. # The domain membership.
+          "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
+        },
+        "metadata": { # Metadata about a field. # Metadata about the membership.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "taglines": [ # The person's taglines.
+      { # A brief one-line description of the person.
+        "value": "A String", # The tagline.
+        "metadata": { # Metadata about a field. # Metadata about the tagline.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "urls": [ # The person's associated URLs.
+      { # A person's associated URLs.
+        "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
+        "value": "A String", # The URL.
+        "metadata": { # Metadata about a field. # Metadata about the URL.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "ageRange": "A String", # The person's age range.
+    "genders": [ # The person's genders.
+      { # A person's gender.
+        "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
+        "metadata": { # Metadata about a field. # Metadata about the gender.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+    "emailAddresses": [ # The person's email addresses.
+      { # A person's email address.
+        "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+        "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+        "value": "A String", # The email address.
+        "metadata": { # Metadata about a field. # Metadata about the email address.
+          "source": { # The source of a field. # The source of the field.
+            "type": "A String", # The source type.
+            "id": "A String", # A unique identifier within the source type generated by the server.
+          },
+          "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+          "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+        },
+      },
+    ],
+  }
+
+ +
+ getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None) +
Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
+
+Args:
+  resourceNames: string, The resource name, such as one returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this parameter up to 50 times in one request. (repeated)
+  x__xgafv: string, V1 error format.
+  requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
+
+Returns:
+  An object of the form:
+
+    {
+    "responses": [ # The response for each requested resource name.
+      { # The response for a single person
+        "requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
+        "person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
+          "phoneNumbers": [ # The person's phone numbers.
+            { # A person's phone number.
+              "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf) form of the phone number.
+              "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
+              "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
+              "value": "A String", # The phone number.
+              "metadata": { # Metadata about a field. # Metadata about the phone number.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "addresses": [ # The person's street addresses.
+            { # A person's physical address. May be a P.O. box or street address. All fields are optional.
+              "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
+              "city": "A String", # The city of the address.
+              "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "region": "A String", # The region of the address; for example, the state or province.
+              "poBox": "A String", # The P.O. box of the address.
+              "streetAddress": "A String", # The street address.
+              "country": "A String", # The country of the address.
+              "postalCode": "A String", # The postal code of the address.
+              "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
+              "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+              "metadata": { # Metadata about a field. # Metadata about the address.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "nicknames": [ # The person's nicknames.
+            { # A person's nickname.
+              "type": "A String", # The type of the nickname.
+              "value": "A String", # The nickname.
+              "metadata": { # Metadata about a field. # Metadata about the nickname.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "occupations": [ # The person's occupations.
+            { # A person's occupation.
+              "value": "A String", # The occupation; for example, `carpenter`.
+              "metadata": { # Metadata about a field. # Metadata about the occupation.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "braggingRights": [ # The person's bragging rights.
+            { # A person's bragging rights.
+              "value": "A String", # The bragging rights; for example, `climbed mount everest`.
+              "metadata": { # Metadata about a field. # Metadata about the bragging rights.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "names": [ # The person's names.
+            { # A person's name. If the name is a mononym, the family name is empty.
+              "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
+              "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
+              "phoneticFamilyName": "A String", # The family name spelled as it sounds.
+              "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
+              "middleName": "A String", # The middle name(s).
+              "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
+              "familyName": "A String", # The family name.
+              "phoneticGivenName": "A String", # The given name spelled as it sounds.
+              "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
+              "givenName": "A String", # The given name.
+              "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
+              "metadata": { # Metadata about a field. # Metadata about the name.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
+          "birthdays": [ # The person's birthdays.
+            { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
+              "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
+                "month": 42, # Month of year. Must be from 1 to 12.
+                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+              },
+              "text": "A String", # A free-form string representing the user's birthday.
+              "metadata": { # Metadata about a field. # Metadata about the birthday.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "relations": [ # The person's relations.
+            { # A person's relation to another person.
+              "person": "A String", # The name of the other person this relation refers to.
+              "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+              "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
+              "metadata": { # Metadata about a field. # Metadata about the relation.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
+          "relationshipStatuses": [ # The person's relationship statuses.
+            { # A person's relationship status.
+              "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
+              "metadata": { # Metadata about a field. # Metadata about the relationship status.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "skills": [ # The person's skills.
+            { # A skill that the person has.
+              "value": "A String", # The skill; for example, `underwater basket weaving`.
+              "metadata": { # Metadata about a field. # Metadata about the skill.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "imClients": [ # The person's instant messaging clients.
+            { # A person's instant messaging client.
+              "username": "A String", # The user name used in the IM client.
+              "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
+              "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+              "metadata": { # Metadata about a field. # Metadata about the IM client.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "events": [ # The person's events.
+            { # An event related to the person.
+              "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
+                "month": 42, # Month of year. Must be from 1 to 12.
+                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+              },
+              "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
+              "metadata": { # Metadata about a field. # Metadata about the event.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "metadata": { # Metadata about a person. # Metadata about the person.
+            "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
+              "A String",
+            ],
+            "sources": [ # The sources of data for the person.
+              { # The source of a field.
+                "type": "A String", # The source type.
+                "id": "A String", # A unique identifier within the source type generated by the server.
+              },
+            ],
+            "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
+            "objectType": "A String", # The type of the person object.
+          },
+          "interests": [ # The person's interests.
+            { # One of the person's interests.
+              "value": "A String", # The interest; for example, `stargazing`.
+              "metadata": { # Metadata about a field. # Metadata about the interest.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "photos": [ # The person's photos.
+            { # A person's photo. A picture shown next to the person's name to help others recognize the person.
+              "url": "A String", # The URL of the photo.
+              "metadata": { # Metadata about a field. # Metadata about the photo.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "residences": [ # The person's residences.
+            { # A person's past or current residence.
+              "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
+              "value": "A String", # The address of the residence.
+              "metadata": { # Metadata about a field. # Metadata about the residence.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "relationshipInterests": [ # The kind of relationship the person is looking for.
+            { # The kind of relationship the person is looking for.
+              "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
+              "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
+              "metadata": { # Metadata about a field. # Metadata about the relationship interest.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "coverPhotos": [ # The person's cover photos.
+            { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
+              "url": "A String", # The URL of the cover photo.
+              "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
+              "metadata": { # Metadata about a field. # Metadata about the cover photo.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "locales": [ # The person's locale preferences.
+            { # A person's locale preference.
+              "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
+              "metadata": { # Metadata about a field. # Metadata about the locale.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "organizations": [ # The person's past or current organizations.
+            { # A person's past or current organization. Overlapping date ranges are permitted.
+              "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
+              "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
+                "month": 42, # Month of year. Must be from 1 to 12.
+                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+              },
+              "name": "A String", # The name of the organization.
+              "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
+                "month": 42, # Month of year. Must be from 1 to 12.
+                "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
+                "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+              },
+              "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
+              "title": "A String", # The person's job title at the organization.
+              "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
+              "jobDescription": "A String", # The person's job description at the organization.
+              "location": "A String", # The location of the organization office the person works at.
+              "department": "A String", # The person's department at the organization.
+              "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
+              "phoneticName": "A String", # The phonetic name of the organization.
+              "metadata": { # Metadata about a field. # Metadata about the organization.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "biographies": [ # The person's biographies.
+            { # A person's short biography.
+              "value": "A String", # The short biography.
+              "metadata": { # Metadata about a field. # Metadata about the biography.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "memberships": [ # The person's group memberships.
+            { # A person's membership in a group.
+              "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
+                "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
+              },
+              "domainMembership": { # A Google Apps Domain membership. # The domain membership.
+                "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
+              },
+              "metadata": { # Metadata about a field. # Metadata about the membership.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "taglines": [ # The person's taglines.
+            { # A brief one-line description of the person.
+              "value": "A String", # The tagline.
+              "metadata": { # Metadata about a field. # Metadata about the tagline.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "urls": [ # The person's associated URLs.
+            { # A person's associated URLs.
+              "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
+              "value": "A String", # The URL.
+              "metadata": { # Metadata about a field. # Metadata about the URL.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "ageRange": "A String", # The person's age range.
+          "genders": [ # The person's genders.
+            { # A person's gender.
+              "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
+              "metadata": { # Metadata about a field. # Metadata about the gender.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+          "emailAddresses": [ # The person's email addresses.
+            { # A person's email address.
+              "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
+              "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
+              "value": "A String", # The email address.
+              "metadata": { # Metadata about a field. # Metadata about the email address.
+                "source": { # The source of a field. # The source of the field.
+                  "type": "A String", # The source type.
+                  "id": "A String", # A unique identifier within the source type generated by the server.
+                },
+                "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
+                "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
+              },
+            },
+          ],
+        },
+        "httpStatusCode": 42, # [HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
+      },
+    ],
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/plusDomains_v1.activities.html b/docs/dyn/plusDomains_v1.activities.html index ded9adc1e3b..de453f38e64 100644 --- a/docs/dyn/plusDomains_v1.activities.html +++ b/docs/dyn/plusDomains_v1.activities.html @@ -164,15 +164,20 @@

Method Details

"selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, which is suitable for display. - "id": "A String", # ID of the original actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # ID of the original actor. }, "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. @@ -203,6 +208,11 @@

Method Details

"image": { # The image representation of the actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, @@ -327,15 +337,20 @@

Method Details

"selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, which is suitable for display. - "id": "A String", # ID of the original actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # ID of the original actor. }, "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. @@ -366,6 +381,11 @@

Method Details

"image": { # The image representation of the actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, @@ -485,15 +505,20 @@

Method Details

"selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, which is suitable for display. - "id": "A String", # ID of the original actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # ID of the original actor. }, "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. @@ -524,6 +549,11 @@

Method Details

"image": { # The image representation of the actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, @@ -659,15 +689,20 @@

Method Details

"selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, which is suitable for display. - "id": "A String", # ID of the original actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # ID of the original actor. }, "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. @@ -698,6 +733,11 @@

Method Details

"image": { # The image representation of the actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, diff --git a/docs/dyn/plusDomains_v1.comments.html b/docs/dyn/plusDomains_v1.comments.html index 15825436b5a..5c53aed1e02 100644 --- a/docs/dyn/plusDomains_v1.comments.html +++ b/docs/dyn/plusDomains_v1.comments.html @@ -116,15 +116,20 @@

Method Details

}, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. + "displayName": "A String", # The name of this actor, suitable for display. "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of this actor, suitable for display. - "id": "A String", # The ID of the actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. @@ -163,15 +168,20 @@

Method Details

}, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. + "displayName": "A String", # The name of this actor, suitable for display. "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of this actor, suitable for display. - "id": "A String", # The ID of the actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. @@ -204,15 +214,20 @@

Method Details

}, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. + "displayName": "A String", # The name of this actor, suitable for display. "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of this actor, suitable for display. - "id": "A String", # The ID of the actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. @@ -263,15 +278,20 @@

Method Details

}, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. + "displayName": "A String", # The name of this actor, suitable for display. "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of this actor, suitable for display. - "id": "A String", # The ID of the actor. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, "verification": { # Verification status of actor. "adHocVerified": "A String", # Verification for one-time or manual processes. }, + "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. diff --git a/docs/dyn/plus_v1.activities.html b/docs/dyn/plus_v1.activities.html index d52a12b2666..386d1c6110f 100644 --- a/docs/dyn/plus_v1.activities.html +++ b/docs/dyn/plus_v1.activities.html @@ -109,6 +109,7 @@

Method Details

}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -116,75 +117,97 @@

Method Details

}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -194,23 +217,35 @@

Method Details

# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }
@@ -225,16 +260,16 @@

Method Details

collection: string, The collection of activities to list. (required) Allowed values public - All public activities created by the specified user. - pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. - maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. + pageToken: string, 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. + maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. Returns: An object of the form: { - "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + "nextPageToken": "A String", # 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. "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed". - "title": "A String", # The title of this collection of activities. + "title": "A String", # The title of this collection of activities, which is a truncated portion of the content. "items": [ # The activities in this page of results. { "placeName": "A String", # Name of the place where this activity occurred. @@ -245,6 +280,7 @@

Method Details

}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -252,75 +288,97 @@

Method Details

}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -330,30 +388,43 @@

Method Details

# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }, ], "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. "nextLink": "A String", # Link to the next page of activities. - "id": "A String", # The ID of this collection of activities. + "etag": "A String", # ETag of this response for caching purposes. + "id": "A String", # The ID of this collection of activities. Deprecated. "selfLink": "A String", # Link to this activity resource. }
@@ -382,17 +453,17 @@

Method Details

Allowed values best - Sort activities by relevance to the user, most relevant first. recent - Sort activities by published date, most recent first. - language: string, Specify the preferred language to search with. See Language Codes for available values. - pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length. - maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. + language: string, Specify the preferred language to search with. See search language codes for available values. + pageToken: string, 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. This token can be of any length. + maxResults: integer, The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. Returns: An object of the form: { - "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. + "nextPageToken": "A String", # 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. "kind": "plus#activityFeed", # Identifies this resource as a collection of activities. Value: "plus#activityFeed". - "title": "A String", # The title of this collection of activities. + "title": "A String", # The title of this collection of activities, which is a truncated portion of the content. "items": [ # The activities in this page of results. { "placeName": "A String", # Name of the place where this activity occurred. @@ -403,6 +474,7 @@

Method Details

}, "title": "A String", # Title of this activity. "url": "A String", # The link to this activity. + "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. "object": { # The object of this activity. "resharers": { # People who reshared this activity. "totalItems": 42, # Total number of people who reshared this activity. @@ -410,75 +482,97 @@

Method Details

}, "attachments": [ # The media objects attached to this activity. { - "displayName": "A String", # The title of the attachment (such as a photo caption or an article title). - "contentsource": { # If the attachment is audio, the link to the content. - "url": "A String", # URL of the link. - "type": "A String", # Media type of the link. - }, - "fullImage": { # The full image url for photo attachments. - "url": "A String", # URL of the link. + "displayName": "A String", # The title of the attachment, such as a photo caption or an article title. + "thumbnails": [ # If the attachment is an album, this property is a list of potential additional thumbnails from the album. + { + "url": "A String", # URL of the webpage containing the image. + "image": { # Image resource. + "url": "A String", # Image url. + "width": 42, # The width, in pixels, of the linked resource. + "type": "A String", # Media type of the link. + "height": 42, # The height, in pixels, of the linked resource. + }, + "description": "A String", # Potential name of the thumbnail. + }, + ], + "fullImage": { # The full image URL for photo attachments. + "url": "A String", # URL of the image. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "url": "A String", # The link to the attachment, should be of type text/html. + "url": "A String", # The link to the attachment, which should be of type text/html. "image": { # The preview image for photos or videos. - "url": "A String", # URL of the link. + "url": "A String", # Image URL. "width": 42, # The width, in pixels, of the linked resource. "type": "A String", # Media type of the link. "height": 42, # The height, in pixels, of the linked resource. }, - "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. + "content": "A String", # If the attachment is an article, this property contains a snippet of text from the article. It can also include descriptions for other types. "embed": { # If the attachment is a video, the embeddable link. "url": "A String", # URL of the link. "type": "A String", # Media type of the link. }, - "id": "A String", # The ID of the media object's resource. - "categories": [ # Specifies zero or more categories the attachment belongs to. - { - "term": "A String", # The tag, e.g. album. - "schema": "A String", # Domain of schema, e.g. http://google.com. - "label": "A String", # The category label, suitable for display (e.g. "album cover"). - }, - ], - "objectType": "A String", # The type of media object. Possible values are: + "id": "A String", # The ID of the attachment. + "objectType": "A String", # The type of media object. Possible values include, but are not limited to, the following values: # - "photo" - A photo. + # - "album" - A photo album. # - "video" - A video. # - "article" - An article, specified by a link. }, ], - "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When updating an activity's content, use the value of originalContent as the starting point from which to make edits. + "originalContent": "A String", # The content (text) as provided by the author, which is stored without any HTML formatting. When creating or updating an activity, this value must be supplied as plain text in the request. "plusoners": { # People who +1'd this activity. "totalItems": 42, # Total number of people who +1'd this activity. "selfLink": "A String", # The URL for the collection of people who +1'd this activity. }, - "actor": { # If this activity's object is itself another activity (for example, when a person reshares an activity), this property specifies the original activity's actor. + "actor": { # If this activity's object is itself another activity, such as when a person reshares an activity, this property specifies the original activity's actor. + "displayName": "A String", # The original actor's name, which is suitable for display. "url": "A String", # A link to the original actor's Google profile. "image": { # The image representation of the original actor. "url": "A String", # A URL that points to a thumbnail photo of the original actor. }, - "displayName": "A String", # The original actor's name, suitable for display. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, "id": "A String", # ID of the original actor. }, - "content": "A String", # The HTML-formatted content, suitable for display. When creating or updating an activity, this value must be supplied as plain text in the request. If successful, the response will contain the HTML-formatted content. When updating an activity, use originalContent as the starting value, then assign the updated text to this property. + "content": "A String", # The HTML-formatted content, which is suitable for display. "url": "A String", # The URL that points to the linked resource. "replies": { # Comments in reply to this activity. "totalItems": 42, # Total number of comments on this activity. "selfLink": "A String", # The URL for the collection of comments in reply to this activity. }, - "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity being reshared. - "objectType": "A String", # The type of the object. Possible values are: + "id": "A String", # The ID of the object. When resharing an activity, this is the ID of the activity that is being reshared. + "objectType": "A String", # The type of the object. Possible values include, but are not limited to, the following values: # - "note" - Textual content. # - "activity" - A Google+ activity. }, "placeId": "A String", # ID of the place where this activity occurred. "actor": { # The person who performed this activity. + "displayName": "A String", # The name of the actor, suitable for display. + "name": { # An object representation of the individual components of name. + "givenName": "A String", # The given name ("first name") of the actor. + "familyName": "A String", # The family name ("last name") of the actor. + }, "url": "A String", # The link to the actor's Google profile. "image": { # The image representation of the actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. }, - "displayName": "A String", # The name of the actor, suitable for display. - "id": "A String", # The ID of the actor's person resource. + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. + }, + "id": "A String", # The ID of the actor's Person resource. }, "id": "A String", # The ID of this activity. "access": { # Identifies who has access to see this activity. @@ -488,30 +582,43 @@

Method Details

# - "person" - Access to an individual. # - "circle" - Access to members of a circle. # - "myCircles" - Access to members of all the person's circles. - # - "extendedCircles" - Access to members of everyone in a person's circles, plus all of the people in their circles. + # - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. + # - "domain" - Access to members of the person's Google Apps domain. # - "public" - Access to anyone on the web. + "displayName": "A String", # A descriptive name for this entry. Suitable for display. "id": "A String", # The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. }, ], "kind": "plus#acl", # Identifies this resource as a collection of access controls. Value: "plus#acl". "description": "A String", # Description of the access granted, suitable for display. }, - "verb": "A String", # This activity's verb, indicating what action was performed. Possible values are: + "verb": "A String", # This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: # - "post" - Publish content to the stream. - # - "checkin" - Check in to a location. # - "share" - Reshare an activity. - "geocode": "A String", # Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. + "etag": "A String", # ETag of this response for caching purposes. "radius": "A String", # Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. + "location": { # The location where this activity occurred. + "position": { # The position of the place. + "latitude": 3.14, # The latitude of this position. + "longitude": 3.14, # The longitude of this position. + }, + "kind": "plus#place", # Identifies this resource as a place. Value: "plus#place". + "displayName": "A String", # The display name of the place. + "id": "A String", # The id of the place. + "address": { # The physical address of the place. + "formatted": "A String", # The formatted address for display. + }, + }, "address": "A String", # Street address where this activity occurred. "crosspostSource": "A String", # If this activity is a crosspost from another system, this property specifies the ID of the original activity. - "placeholder": True or False, # True if this activity is a placeholder. "annotation": "A String", # Additional content added by the person who shared this activity, applicable only when resharing an activity. "published": "A String", # The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. }, ], "updated": "A String", # The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. "nextLink": "A String", # Link to the next page of activities. - "id": "A String", # The ID of this collection of activities. + "etag": "A String", # ETag of this response for caching purposes. + "id": "A String", # The ID of this collection of activities. Deprecated. "selfLink": "A String", # Link to this activity resource. }
diff --git a/docs/dyn/plus_v1.comments.html b/docs/dyn/plus_v1.comments.html index e0e0e1b3e37..7565bdb949f 100644 --- a/docs/dyn/plus_v1.comments.html +++ b/docs/dyn/plus_v1.comments.html @@ -78,7 +78,7 @@

Instance Methods

get(commentId)

Get a comment.

- list(activityId, pageToken=None, maxResults=None)

+ list(activityId, pageToken=None, maxResults=None, sortOrder=None)

List all of the comments for an activity.

list_next(previous_request, previous_response)

@@ -97,27 +97,40 @@

Method Details

{ "inReplyTo": [ # The activity this comment replied to. { - "url": "A String", # The url of the activity. - "id": "A String", # The id of the activity. + "url": "A String", # The URL of the activity. + "id": "A String", # The ID of the activity. }, ], "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment". + "plusoners": { # People who +1'd this comment. + "totalItems": 42, # Total number of people who +1'd this comment. + }, "object": { # The object of this comment. - "content": "A String", # The content of this comment. + "content": "A String", # The HTML-formatted content, suitable for display. + "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request. "objectType": "comment", # The object type of this comment. Possible values are: # - "comment" - A comment in reply to an activity. }, "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. "actor": { # The person who posted this comment. - "url": "A String", # A link to the person resource for this actor. + "displayName": "A String", # The name of this actor, suitable for display. + "url": "A String", # A link to the Person resource for this actor. "image": { # The image representation of this actor. - "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + }, + "clientSpecificActorInfo": { # Actor info specific to particular clients. + "youtubeActorInfo": { # Actor info specific to YouTube clients. + "channelId": "A String", # ID of the YouTube channel owned by the Actor. + }, + }, + "verification": { # Verification status of actor. + "adHocVerified": "A String", # Verification for one-time or manual processes. }, - "displayName": "A String", # The name of this actor, suitable for display. "id": "A String", # The ID of the actor. }, "verb": "post", # This comment's verb, indicating what action was performed. Possible values are: # - "post" - Publish content to the stream. + "etag": "A String", # ETag of this response for caching purposes. "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. "id": "A String", # The ID of this comment. "selfLink": "A String", # Link to this comment resource. @@ -125,46 +138,63 @@

Method Details

- list(activityId, pageToken=None, maxResults=None) + list(activityId, pageToken=None, maxResults=None, sortOrder=None)
List all of the comments for an activity.
 
 Args:
   activityId: string, The ID of the activity to get comments for. (required)
-  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
-  maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+  pageToken: string, 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.
+  maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+  sortOrder: string, The order in which to sort the list of comments.
+    Allowed values
+      ascending - Sort oldest comments first.
+      descending - Sort newest comments first.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+    "nextPageToken": "A String", # 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.
     "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
     "title": "A String", # The title of this collection of comments.
     "items": [ # The comments in this page of results.
       {
         "inReplyTo": [ # The activity this comment replied to.
           {
-            "url": "A String", # The url of the activity.
-            "id": "A String", # The id of the activity.
+            "url": "A String", # The URL of the activity.
+            "id": "A String", # The ID of the activity.
           },
         ],
         "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
+        "plusoners": { # People who +1'd this comment.
+          "totalItems": 42, # Total number of people who +1'd this comment.
+        },
         "object": { # The object of this comment.
-          "content": "A String", # The content of this comment.
+          "content": "A String", # The HTML-formatted content, suitable for display.
+          "originalContent": "A String", # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
           "objectType": "comment", # The object type of this comment. Possible values are:
               # - "comment" - A comment in reply to an activity.
         },
         "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
         "actor": { # The person who posted this comment.
-          "url": "A String", # A link to the person resource for this actor.
+          "displayName": "A String", # The name of this actor, suitable for display.
+          "url": "A String", # A link to the Person resource for this actor.
           "image": { # The image representation of this actor.
-            "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+            "url": "A String", # The URL of the actor's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          },
+          "clientSpecificActorInfo": { # Actor info specific to particular clients.
+            "youtubeActorInfo": { # Actor info specific to YouTube clients.
+              "channelId": "A String", # ID of the YouTube channel owned by the Actor.
+            },
+          },
+          "verification": { # Verification status of actor.
+            "adHocVerified": "A String", # Verification for one-time or manual processes.
           },
-          "displayName": "A String", # The name of this actor, suitable for display.
           "id": "A String", # The ID of the actor.
         },
         "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
             # - "post" - Publish content to the stream.
+        "etag": "A String", # ETag of this response for caching purposes.
         "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
         "id": "A String", # The ID of this comment.
         "selfLink": "A String", # Link to this comment resource.
@@ -172,6 +202,7 @@ 

Method Details

], "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. "nextLink": "A String", # Link to the next page of activities. + "etag": "A String", # ETag of this response for caching purposes. "id": "A String", # The ID of this collection of comments. }
diff --git a/docs/dyn/plus_v1.people.html b/docs/dyn/plus_v1.people.html index 9e4638eafd4..e23259ec84a 100644 --- a/docs/dyn/plus_v1.people.html +++ b/docs/dyn/plus_v1.people.html @@ -76,13 +76,19 @@

Google+ API . peopl

Instance Methods

get(userId)

-

Get a person's profile.

+

Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.

+

+ list(userId, collection, orderBy=None, pageToken=None, maxResults=None)

+

List all of the people in the specified collection.

listByActivity(activityId, collection, pageToken=None, maxResults=None)

List all of the people in the specified collection for a particular activity.

listByActivity_next(previous_request, previous_response)

Retrieves the next page of results.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

search(query, pageToken=None, language=None, maxResults=None)

Search all public profiles.

@@ -92,7 +98,7 @@

Instance Methods

Method Details

get(userId) -
Get a person's profile.
+  
Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.
 
 Args:
   userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)
@@ -101,7 +107,23 @@ 

Method Details

An object of the form: { - "relationshipStatus": "A String", # The person's relationship status. Possible values are: + "braggingRights": "A String", # The "bragging rights" line of this person. + "image": { # The representation of the person's profile photo. + "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "isDefault": True or False, # Whether the person's profile photo is the default one + }, + "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. + "id": "A String", # The ID of this person. + "occupation": "A String", # The occupation of this person. + "verified": True or False, # Whether the person or Google+ Page has been verified. + "tagline": "A String", # The brief description (tagline) of this person. + "currentLocation": "A String", # (this field is not currently used) + "etag": "A String", # ETag of this response for caching purposes. + "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle. + "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values: + # - "person" - represents an actual person. + # - "page" - represents a page. + "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values: # - "single" - Person is single. # - "in_a_relationship" - Person is in a relationship. # - "engaged" - Person is engaged. @@ -111,23 +133,42 @@

Method Details

# - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. + "aboutMe": "A String", # A short biography for this person. + "placesLived": [ # A list of places where this person has lived. + { + "primary": True or False, # If "true", this place of residence is this person's primary residence. + "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + }, + ], + "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + "nickname": "A String", # The nickname of this person. + "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. + { + "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: + # - "account" - Google account email address. + # - "home" - Home email address. + # - "work" - Work email address. + # - "other" - Other. + "value": "A String", # The email address. + }, + ], "organizations": [ # A list of current or past organizations with which this person is associated. { - "startDate": "A String", # The date the person joined this organization. - "endDate": "A String", # The date the person left this organization. - "description": "A String", # A short description of the person's role in this organization. + "startDate": "A String", # The date that the person joined this organization. + "endDate": "A String", # The date that the person left this organization. + "description": "A String", # A short description of the person's role in this organization. Deprecated. "title": "A String", # The person's job title or role within the organization. - "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one). - "location": "A String", # The location of this organization. - "department": "A String", # The department within the organization. - "type": "A String", # The type of organization. Possible values are: + "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. + "location": "A String", # The location of this organization. Deprecated. + "department": "A String", # The department within the organization. Deprecated. + "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: # - "work" - Work. # - "school" - School. "name": "A String", # The name of the organization. }, ], "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". - "displayName": "A String", # The name of this person, suitable for display. + "displayName": "A String", # The name of this person, which is suitable for display. "name": { # An object representation of the individual components of a person's name. "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. "middleName": "A String", # The middle name of this person. @@ -136,76 +177,93 @@

Method Details

"givenName": "A String", # The given name (first name) of this person. "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. }, - "url": "A String", # The URL of this person's profile. - "gender": "A String", # The person's gender. Possible values are: + "language": "A String", # The user's preferred language for rendering. + "skills": "A String", # The person's skills. + "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. - "aboutMe": "A String", # A short biography for this person. - "tagline": "A String", # The brief description (tagline) of this person. - "placesLived": [ # A list of places where this person has lived. - { - "primary": True or False, # If "true", this place of residence is this person's primary residence. - "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + "cover": { # The cover photo content. + "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: + # - "banner" - One large image banner. + "coverInfo": { # Extra information about the cover photo. + "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. + "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. }, - ], - "emails": [ # A list of email addresses for this person. - { - "type": "A String", # The type of address. Possible values are: - # - "home" - Home email address. - # - "work" - Work email address. - # - "other" - Other. - "primary": True or False, # If "true", indicates this email address is the person's primary one. - "value": "A String", # The email address. + "coverPhoto": { # The person's primary cover image. + "url": "A String", # The URL of the image. + "width": 42, # The width of the image. + "height": 42, # The height of the image. }, - ], - "nickname": "A String", # The nickname of this person. - "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + }, + "url": "A String", # The URL of this person's profile. + "isPlusUser": True or False, # Whether this user has signed up for Google+. + "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. "urls": [ # A list of URLs for this person. { - "type": "A String", # The type of URL. Possible values are: - # - "home" - URL for home. - # - "work" - URL for work. - # - "blog" - URL for blog. - # - "profile" - URL for profile. - # - "other" - Other. - "primary": True or False, # If "true", this URL is the person's primary URL. + "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: + # - "otherProfile" - URL for another profile. + # - "contributor" - URL to a site for which this person is a contributor. + # - "website" - URL for this Google+ Page's primary website. + # - "other" - Other URL. "value": "A String", # The URL value. + "label": "A String", # The label of the URL. }, ], - "image": { # The representation of the person's profile photo. - "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. + "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following: + # - "17" - for age 17 + # - "20" - for age 20 + "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following: + # - "21" - for age 21 + # - "18" - for age 18 }, - "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private). - "id": "A String", # The ID of this person. - "languagesSpoken": [ # The languages spoken by this person. - "A String", - ], - "currentLocation": "A String", # The current location for this person. }
- listByActivity(activityId, collection, pageToken=None, maxResults=None) -
List all of the people in the specified collection for a particular activity.
+    list(userId, collection, orderBy=None, pageToken=None, maxResults=None)
+  
List all of the people in the specified collection.
 
 Args:
-  activityId: string, The ID of the activity to get the list of people for. (required)
+  userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)
   collection: string, The collection of people to list. (required)
     Allowed values
-      plusoners - List all people who have +1'd this activity.
-      resharers - List all people who have reshared this activity.
-  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
-  maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+      connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user.
+      visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.
+  orderBy: string, The order to return people in.
+    Allowed values
+      alphabetical - Order the people by their display name.
+      best - Order people based on the relevence to the viewer.
+  pageToken: string, 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.
+  maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
-    "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+    "nextPageToken": "A String", # 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.
+    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "title": "A String", # The title of this collection of people.
+    "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
       {
-        "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+        "braggingRights": "A String", # The "bragging rights" line of this person.
+        "image": { # The representation of the person's profile photo.
+          "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          "isDefault": True or False, # Whether the person's profile photo is the default one
+        },
+        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+        "id": "A String", # The ID of this person.
+        "occupation": "A String", # The occupation of this person.
+        "verified": True or False, # Whether the person or Google+ Page has been verified.
+        "tagline": "A String", # The brief description (tagline) of this person.
+        "currentLocation": "A String", # (this field is not currently used)
+        "etag": "A String", # ETag of this response for caching purposes.
+        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+        "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+            # - "person" - represents an actual person.
+            # - "page" - represents a page.
+        "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
             # - "single" - Person is single.
             # - "in_a_relationship" - Person is in a relationship.
             # - "engaged" - Person is engaged.
@@ -215,23 +273,42 @@ 

Method Details

# - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. + "aboutMe": "A String", # A short biography for this person. + "placesLived": [ # A list of places where this person has lived. + { + "primary": True or False, # If "true", this place of residence is this person's primary residence. + "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + }, + ], + "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + "nickname": "A String", # The nickname of this person. + "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. + { + "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: + # - "account" - Google account email address. + # - "home" - Home email address. + # - "work" - Work email address. + # - "other" - Other. + "value": "A String", # The email address. + }, + ], "organizations": [ # A list of current or past organizations with which this person is associated. { - "startDate": "A String", # The date the person joined this organization. - "endDate": "A String", # The date the person left this organization. - "description": "A String", # A short description of the person's role in this organization. + "startDate": "A String", # The date that the person joined this organization. + "endDate": "A String", # The date that the person left this organization. + "description": "A String", # A short description of the person's role in this organization. Deprecated. "title": "A String", # The person's job title or role within the organization. - "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one). - "location": "A String", # The location of this organization. - "department": "A String", # The department within the organization. - "type": "A String", # The type of organization. Possible values are: + "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. + "location": "A String", # The location of this organization. Deprecated. + "department": "A String", # The department within the organization. Deprecated. + "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: # - "work" - Work. # - "school" - School. "name": "A String", # The name of the organization. }, ], "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". - "displayName": "A String", # The name of this person, suitable for display. + "displayName": "A String", # The name of this person, which is suitable for display. "name": { # An object representation of the individual components of a person's name. "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. "middleName": "A String", # The middle name of this person. @@ -240,57 +317,193 @@

Method Details

"givenName": "A String", # The given name (first name) of this person. "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. }, - "url": "A String", # The URL of this person's profile. - "gender": "A String", # The person's gender. Possible values are: + "language": "A String", # The user's preferred language for rendering. + "skills": "A String", # The person's skills. + "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. - "aboutMe": "A String", # A short biography for this person. + "cover": { # The cover photo content. + "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: + # - "banner" - One large image banner. + "coverInfo": { # Extra information about the cover photo. + "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. + "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. + }, + "coverPhoto": { # The person's primary cover image. + "url": "A String", # The URL of the image. + "width": 42, # The width of the image. + "height": 42, # The height of the image. + }, + }, + "url": "A String", # The URL of this person's profile. + "isPlusUser": True or False, # Whether this user has signed up for Google+. + "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. + "urls": [ # A list of URLs for this person. + { + "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: + # - "otherProfile" - URL for another profile. + # - "contributor" - URL to a site for which this person is a contributor. + # - "website" - URL for this Google+ Page's primary website. + # - "other" - Other URL. + "value": "A String", # The URL value. + "label": "A String", # The label of the URL. + }, + ], + "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. + "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following: + # - "17" - for age 17 + # - "20" - for age 20 + "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following: + # - "21" - for age 21 + # - "18" - for age 18 + }, + }, + ], + "etag": "A String", # ETag of this response for caching purposes. + "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. + "selfLink": "A String", # Link to this resource. + }
+
+ +
+ listByActivity(activityId, collection, pageToken=None, maxResults=None) +
List all of the people in the specified collection for a particular activity.
+
+Args:
+  activityId: string, The ID of the activity to get the list of people for. (required)
+  collection: string, The collection of people to list. (required)
+    Allowed values
+      plusoners - List all people who have +1'd this activity.
+      resharers - List all people who have reshared this activity.
+  pageToken: string, 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.
+  maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
+
+Returns:
+  An object of the form:
+
+    {
+    "nextPageToken": "A String", # 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.
+    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "title": "A String", # The title of this collection of people.
+    "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+      {
+        "braggingRights": "A String", # The "bragging rights" line of this person.
+        "image": { # The representation of the person's profile photo.
+          "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          "isDefault": True or False, # Whether the person's profile photo is the default one
+        },
+        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+        "id": "A String", # The ID of this person.
+        "occupation": "A String", # The occupation of this person.
+        "verified": True or False, # Whether the person or Google+ Page has been verified.
         "tagline": "A String", # The brief description (tagline) of this person.
+        "currentLocation": "A String", # (this field is not currently used)
+        "etag": "A String", # ETag of this response for caching purposes.
+        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+        "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+            # - "person" - represents an actual person.
+            # - "page" - represents a page.
+        "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
+            # - "single" - Person is single.
+            # - "in_a_relationship" - Person is in a relationship.
+            # - "engaged" - Person is engaged.
+            # - "married" - Person is married.
+            # - "its_complicated" - The relationship is complicated.
+            # - "open_relationship" - Person is in an open relationship.
+            # - "widowed" - Person is widowed.
+            # - "in_domestic_partnership" - Person is in a domestic partnership.
+            # - "in_civil_union" - Person is in a civil union.
+        "aboutMe": "A String", # A short biography for this person.
         "placesLived": [ # A list of places where this person has lived.
           {
             "primary": True or False, # If "true", this place of residence is this person's primary residence.
             "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".
           },
         ],
-        "emails": [ # A list of email addresses for this person.
+        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+        "nickname": "A String", # The nickname of this person.
+        "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.
           {
-            "type": "A String", # The type of address. Possible values are:
+            "type": "A String", # The type of address. Possible values include, but are not limited to, the following values:
+                # - "account" - Google account email address.
                 # - "home" - Home email address.
                 # - "work" - Work email address.
                 # - "other" - Other.
-            "primary": True or False, # If "true", indicates this email address is the person's primary one.
             "value": "A String", # The email address.
           },
         ],
-        "nickname": "A String", # The nickname of this person.
-        "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
+        "organizations": [ # A list of current or past organizations with which this person is associated.
+          {
+            "startDate": "A String", # The date that the person joined this organization.
+            "endDate": "A String", # The date that the person left this organization.
+            "description": "A String", # A short description of the person's role in this organization. Deprecated.
+            "title": "A String", # The person's job title or role within the organization.
+            "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.
+            "location": "A String", # The location of this organization. Deprecated.
+            "department": "A String", # The department within the organization. Deprecated.
+            "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:
+                # - "work" - Work.
+                # - "school" - School.
+            "name": "A String", # The name of the organization.
+          },
+        ],
+        "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".
+        "displayName": "A String", # The name of this person, which is suitable for display.
+        "name": { # An object representation of the individual components of a person's name.
+          "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.
+          "middleName": "A String", # The middle name of this person.
+          "familyName": "A String", # The family name (last name) of this person.
+          "formatted": "A String", # The full name of this person, including middle names, suffixes, etc.
+          "givenName": "A String", # The given name (first name) of this person.
+          "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.
+        },
+        "language": "A String", # The user's preferred language for rendering.
+        "skills": "A String", # The person's skills.
+        "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:
+            # - "male" - Male gender.
+            # - "female" - Female gender.
+            # - "other" - Other.
+        "cover": { # The cover photo content.
+          "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:
+              # - "banner" - One large image banner.
+          "coverInfo": { # Extra information about the cover photo.
+            "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.
+            "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.
+          },
+          "coverPhoto": { # The person's primary cover image.
+            "url": "A String", # The URL of the image.
+            "width": 42, # The width of the image.
+            "height": 42, # The height of the image.
+          },
+        },
+        "url": "A String", # The URL of this person's profile.
+        "isPlusUser": True or False, # Whether this user has signed up for Google+.
+        "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.
         "urls": [ # A list of URLs for this person.
           {
-            "type": "A String", # The type of URL. Possible values are:
-                # - "home" - URL for home.
-                # - "work" - URL for work.
-                # - "blog" - URL for blog.
-                # - "profile" - URL for profile.
-                # - "other" - Other.
-            "primary": True or False, # If "true", this URL is the person's primary URL.
+            "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:
+                # - "otherProfile" - URL for another profile.
+                # - "contributor" - URL to a site for which this person is a contributor.
+                # - "website" - URL for this Google+ Page's primary website.
+                # - "other" - Other URL.
             "value": "A String", # The URL value.
+            "label": "A String", # The label of the URL.
           },
         ],
-        "image": { # The representation of the person's profile photo.
-          "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+        "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.
+          "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:
+              # - "17" - for age 17
+              # - "20" - for age 20
+          "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:
+              # - "21" - for age 21
+              # - "18" - for age 18
         },
-        "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private).
-        "id": "A String", # The ID of this person.
-        "languagesSpoken": [ # The languages spoken by this person.
-          "A String",
-        ],
-        "currentLocation": "A String", # The current location for this person.
       },
     ],
-    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "etag": "A String", # ETag of this response for caching purposes.
+    "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.
     "selfLink": "A String", # Link to this resource.
-    "title": "A String", # The title of this collection of people.
   }
@@ -308,24 +521,56 @@

Method Details

+
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+
search(query, pageToken=None, language=None, maxResults=None)
Search all public profiles.
 
 Args:
-  query: string, Full-text search query string. (required)
-  pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.
-  language: string, Specify the preferred language to search with. See Language Codes for available values.
-  maxResults: integer, The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
+  query: string, Specify a query string for full text search of public text in all profiles. (required)
+  pageToken: string, 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. This token can be of any length.
+  language: string, Specify the preferred language to search with. See search language codes for available values.
+  maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
 
 Returns:
   An object of the form:
 
     {
-    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
-    "items": [ # The people in this page of results. Each item will include the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
+    "nextPageToken": "A String", # 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.
+    "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".
+    "title": "A String", # The title of this collection of people.
+    "items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.
       {
-        "relationshipStatus": "A String", # The person's relationship status. Possible values are:
+        "braggingRights": "A String", # The "bragging rights" line of this person.
+        "image": { # The representation of the person's profile photo.
+          "url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
+          "isDefault": True or False, # Whether the person's profile photo is the default one
+        },
+        "domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.
+        "id": "A String", # The ID of this person.
+        "occupation": "A String", # The occupation of this person.
+        "verified": True or False, # Whether the person or Google+ Page has been verified.
+        "tagline": "A String", # The brief description (tagline) of this person.
+        "currentLocation": "A String", # (this field is not currently used)
+        "etag": "A String", # ETag of this response for caching purposes.
+        "circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.
+        "objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:
+            # - "person" - represents an actual person.
+            # - "page" - represents a page.
+        "relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:
             # - "single" - Person is single.
             # - "in_a_relationship" - Person is in a relationship.
             # - "engaged" - Person is engaged.
@@ -335,23 +580,42 @@ 

Method Details

# - "widowed" - Person is widowed. # - "in_domestic_partnership" - Person is in a domestic partnership. # - "in_civil_union" - Person is in a civil union. + "aboutMe": "A String", # A short biography for this person. + "placesLived": [ # A list of places where this person has lived. + { + "primary": True or False, # If "true", this place of residence is this person's primary residence. + "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + }, + ], + "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + "nickname": "A String", # The nickname of this person. + "emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. + { + "type": "A String", # The type of address. Possible values include, but are not limited to, the following values: + # - "account" - Google account email address. + # - "home" - Home email address. + # - "work" - Work email address. + # - "other" - Other. + "value": "A String", # The email address. + }, + ], "organizations": [ # A list of current or past organizations with which this person is associated. { - "startDate": "A String", # The date the person joined this organization. - "endDate": "A String", # The date the person left this organization. - "description": "A String", # A short description of the person's role in this organization. + "startDate": "A String", # The date that the person joined this organization. + "endDate": "A String", # The date that the person left this organization. + "description": "A String", # A short description of the person's role in this organization. Deprecated. "title": "A String", # The person's job title or role within the organization. - "primary": True or False, # If "true", indicates this organization is the person's primary one (typically interpreted as current one). - "location": "A String", # The location of this organization. - "department": "A String", # The department within the organization. - "type": "A String", # The type of organization. Possible values are: + "primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one. + "location": "A String", # The location of this organization. Deprecated. + "department": "A String", # The department within the organization. Deprecated. + "type": "A String", # The type of organization. Possible values include, but are not limited to, the following values: # - "work" - Work. # - "school" - School. "name": "A String", # The name of the organization. }, ], "kind": "plus#person", # Identifies this resource as a person. Value: "plus#person". - "displayName": "A String", # The name of this person, suitable for display. + "displayName": "A String", # The name of this person, which is suitable for display. "name": { # An object representation of the individual components of a person's name. "honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person. "middleName": "A String", # The middle name of this person. @@ -360,57 +624,52 @@

Method Details

"givenName": "A String", # The given name (first name) of this person. "honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person. }, - "url": "A String", # The URL of this person's profile. - "gender": "A String", # The person's gender. Possible values are: + "language": "A String", # The user's preferred language for rendering. + "skills": "A String", # The person's skills. + "gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values: # - "male" - Male gender. # - "female" - Female gender. # - "other" - Other. - "aboutMe": "A String", # A short biography for this person. - "tagline": "A String", # The brief description (tagline) of this person. - "placesLived": [ # A list of places where this person has lived. - { - "primary": True or False, # If "true", this place of residence is this person's primary residence. - "value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto". + "cover": { # The cover photo content. + "layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values: + # - "banner" - One large image banner. + "coverInfo": { # Extra information about the cover photo. + "leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout. + "topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout. }, - ], - "emails": [ # A list of email addresses for this person. - { - "type": "A String", # The type of address. Possible values are: - # - "home" - Home email address. - # - "work" - Work email address. - # - "other" - Other. - "primary": True or False, # If "true", indicates this email address is the person's primary one. - "value": "A String", # The email address. + "coverPhoto": { # The person's primary cover image. + "url": "A String", # The URL of the image. + "width": 42, # The width of the image. + "height": 42, # The height of the image. }, - ], - "nickname": "A String", # The nickname of this person. - "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD. + }, + "url": "A String", # The URL of this person's profile. + "isPlusUser": True or False, # Whether this user has signed up for Google+. + "plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page. "urls": [ # A list of URLs for this person. { - "type": "A String", # The type of URL. Possible values are: - # - "home" - URL for home. - # - "work" - URL for work. - # - "blog" - URL for blog. - # - "profile" - URL for profile. - # - "other" - Other. - "primary": True or False, # If "true", this URL is the person's primary URL. + "type": "A String", # The type of URL. Possible values include, but are not limited to, the following values: + # - "otherProfile" - URL for another profile. + # - "contributor" - URL to a site for which this person is a contributor. + # - "website" - URL for this Google+ Page's primary website. + # - "other" - Other URL. "value": "A String", # The URL value. + "label": "A String", # The label of the URL. }, ], - "image": { # The representation of the person's profile photo. - "url": "A String", # The URL of the person's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side. + "ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. + "max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following: + # - "17" - for age 17 + # - "20" - for age 20 + "min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following: + # - "21" - for age 21 + # - "18" - for age 18 }, - "hasApp": True or False, # If "true", indicates that the person has installed the app that is making the request and has chosen to expose this install state to the caller. A value of "false" indicates that the install state cannot be determined (it is either not installed or the person has chosen to keep this information private). - "id": "A String", # The ID of this person. - "languagesSpoken": [ # The languages spoken by this person. - "A String", - ], - "currentLocation": "A String", # The current location for this person. }, ], - "kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed". + "etag": "A String", # ETag of this response for caching purposes. + "totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. "selfLink": "A String", # Link to this resource. - "title": "A String", # The title of this collection of people. }
diff --git a/docs/dyn/prediction_v1_6.hostedmodels.html b/docs/dyn/prediction_v1_6.hostedmodels.html index b4d79fbbb36..69e85d19d16 100644 --- a/docs/dyn/prediction_v1_6.hostedmodels.html +++ b/docs/dyn/prediction_v1_6.hostedmodels.html @@ -110,7 +110,7 @@

Method Details

"label": "A String", # The class label. }, ], - "outputValue": "A String", # The estimated regression value (Regression models only). + "outputValue": 3.14, # The estimated regression value (Regression models only). "selfLink": "A String", # A URL to re-request this resource. }
diff --git a/docs/dyn/prediction_v1_6.trainedmodels.html b/docs/dyn/prediction_v1_6.trainedmodels.html index a0de1372043..c591ff30870 100644 --- a/docs/dyn/prediction_v1_6.trainedmodels.html +++ b/docs/dyn/prediction_v1_6.trainedmodels.html @@ -376,7 +376,7 @@

Method Details

"label": "A String", # The class label. }, ], - "outputValue": "A String", # The estimated regression value (Regression models only). + "outputValue": 3.14, # The estimated regression value (Regression models only). "selfLink": "A String", # A URL to re-request this resource. }
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 76d6de0a8ae..1aa540b5bac 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -76,19 +76,19 @@

Google Cloud Pub/Sub API . acknowledge(subscription, body, x__xgafv=None)

-

Acknowledges the messages associated with the ack tokens in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

+

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

create(name, body, x__xgafv=None)

-

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.

+

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.

delete(subscription, x__xgafv=None)

-

Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.

+

Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.

get(subscription, x__xgafv=None)

Gets the configuration details of a subscription.

getIamPolicy(resource, x__xgafv=None)

-

Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

+

Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching subscriptions.

@@ -100,10 +100,10 @@

Instance Methods

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted.

modifyPushConfig(subscription, body, x__xgafv=None)

-

Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

+

Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

pull(subscription, body, x__xgafv=None)

-

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

+

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

@@ -113,7 +113,7 @@

Instance Methods

Method Details

acknowledge(subscription, body, x__xgafv=None) -
Acknowledges the messages associated with the ack tokens in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
+  
Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.
 
 Args:
   subscription: string, The subscription whose message is being acknowledged. (required)
@@ -121,7 +121,7 @@ 

Method Details

The object takes the form of: { # Request for the Acknowledge method. - "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty. + "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. "A String", ], } @@ -137,7 +137,7 @@

Method Details

create(name, body, x__xgafv=None) -
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.
+  
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.
 
 Args:
   name: string, The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. (required)
@@ -146,9 +146,9 @@ 

Method Details

{ # A subscription resource. "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. - "ackDeadlineSeconds": 42, # 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. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. - "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. + "ackDeadlineSeconds": 42, # 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. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. "a_key": "A String", }, "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". @@ -163,9 +163,9 @@

Method Details

{ # A subscription resource. "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. - "ackDeadlineSeconds": 42, # 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. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. - "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. + "ackDeadlineSeconds": 42, # 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. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. "a_key": "A String", }, "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". @@ -176,7 +176,7 @@

Method Details

delete(subscription, x__xgafv=None) -
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
+  
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.
 
 Args:
   subscription: string, The subscription to delete. (required)
@@ -202,9 +202,9 @@ 

Method Details

{ # A subscription resource. "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. - "ackDeadlineSeconds": 42, # 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. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. - "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. + "ackDeadlineSeconds": 42, # 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. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. "a_key": "A String", }, "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". @@ -215,25 +215,25 @@

Method Details

getIamPolicy(resource, x__xgafv=None) -
Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.
+  
Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
+  resource: string, 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. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
-    "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
-      { # Associates members with roles. See below for allowed formats of members.
-        "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
-        "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
+    { # 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).
+    "bindings": [ # 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.
+      { # Associates `members` with a `role`.
+        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+        "members": [ # 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`.
           "A String",
         ],
       },
     ],
-    "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
+    "version": 42, # Version of the `Policy`. The default version is 0.
     "etag": "A String", # Can be used to perform a read-modify-write.
   }
@@ -245,20 +245,20 @@

Method Details

Args: project: string, The name of the cloud project that subscriptions belong to. (required) pageSize: integer, Maximum number of subscriptions to return. - pageToken: string, The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data. + pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Returns: An object of the form: - { # Response for the ListSubscriptions method. - "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListSubscriptionsRequest to get more subscriptions. + { # Response for the `ListSubscriptions` method. + "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions. "subscriptions": [ # The subscriptions that match the request. { # A subscription resource. "topic": "A String", # The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted. - "ackDeadlineSeconds": 42, # 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. - "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. - "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. + "ackDeadlineSeconds": 42, # 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. + "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods. + "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. "a_key": "A String", }, "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". @@ -293,7 +293,7 @@

Method Details

The object takes the form of: { # Request for the ModifyAckDeadline method. - "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request. + "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request. "ackIds": [ # List of acknowledgment IDs. "A String", ], @@ -310,7 +310,7 @@

Method Details

modifyPushConfig(subscription, body, x__xgafv=None) -
Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.
+  
Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
 
 Args:
   subscription: string, The name of the subscription. (required)
@@ -318,8 +318,8 @@ 

Method Details

The object takes the form of: { # Request for the ModifyPushConfig method. - "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull is not called. - "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. + "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called. + "attributes": { # Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. "a_key": "A String", }, "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". @@ -337,15 +337,15 @@

Method Details

pull(subscription, body, x__xgafv=None) -
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.
+  
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.
 
 Args:
   subscription: string, The subscription from which messages should be pulled. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
-{ # Request for the Pull method.
-    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
+{ # Request for the `Pull` method.
+    "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
     "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
   }
 
@@ -354,8 +354,8 @@ 

Method Details

Returns: An object of the form: - { # Response for the Pull method. - "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog. + { # Response for the `Pull` method. + "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog. { # A message and its corresponding acknowledgment ID. "ackId": "A String", # This ID can be used to acknowledge the received message. "message": { # A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. # The message. @@ -363,7 +363,8 @@

Method Details

"a_key": "A String", }, "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded. - "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call. + "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. + "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. }, }, ], @@ -375,21 +376,21 @@

Method Details

Sets the access control policy on the specified resource. Replaces any existing policy.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being specified. Resource is usually specified as a path, such as, projects/{project}/zones/{zone}/disks/{disk}. (required)
+  resource: string, 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. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `SetIamPolicy` method.
-    "policy": { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
-      "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
-        { # Associates members with roles. See below for allowed formats of members.
-          "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
-          "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
+    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+      "bindings": [ # 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.
+        { # Associates `members` with a `role`.
+          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+          "members": [ # 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`.
             "A String",
           ],
         },
       ],
-      "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
+      "version": 42, # Version of the `Policy`. The default version is 0.
       "etag": "A String", # Can be used to perform a read-modify-write.
     },
   }
@@ -399,16 +400,16 @@ 

Method Details

Returns: An object of the form: - { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` - "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members. - { # Associates members with roles. See below for allowed formats of members. - "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required - "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com + { # 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). + "bindings": [ # 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. + { # Associates `members` with a `role`. + "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required + "members": [ # 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`. "A String", ], }, ], - "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0. + "version": 42, # Version of the `Policy`. The default version is 0. "etag": "A String", # Can be used to perform a read-modify-write. }
@@ -418,12 +419,12 @@

Method Details

Returns permissions that a caller has on the specified resource.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy detail is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
+  resource: string, 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. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `TestIamPermissions` method.
-    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
       "A String",
     ],
   }
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
index c37f44ec340..828c8981b6f 100644
--- a/docs/dyn/pubsub_v1.projects.topics.html
+++ b/docs/dyn/pubsub_v1.projects.topics.html
@@ -84,13 +84,13 @@ 

Instance Methods

Creates the given topic with the given name.

delete(topic, x__xgafv=None)

-

Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

+

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

get(topic, x__xgafv=None)

Gets the configuration of a topic.

getIamPolicy(resource, x__xgafv=None)

-

Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

+

Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.

list(project, pageSize=None, pageToken=None, x__xgafv=None)

Lists matching topics.

@@ -99,7 +99,7 @@

Instance Methods

Retrieves the next page of results.

publish(topic, body, x__xgafv=None)

-

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

+

Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

setIamPolicy(resource, body, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy.

@@ -132,7 +132,7 @@

Method Details

delete(topic, x__xgafv=None) -
Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
+  
Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
 
 Args:
   topic: string, Name of the topic to delete. (required)
@@ -163,25 +163,25 @@ 

Method Details

getIamPolicy(resource, x__xgafv=None) -
Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.
+  
Gets the access control policy for a `resource`. Is empty if the policy or the resource does not exist.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
+  resource: string, 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. (required)
   x__xgafv: string, V1 error format.
 
 Returns:
   An object of the form:
 
-    { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```
-    "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
-      { # Associates members with roles. See below for allowed formats of members.
-        "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
-        "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
+    { # 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).
+    "bindings": [ # 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.
+      { # Associates `members` with a `role`.
+        "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+        "members": [ # 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`.
           "A String",
         ],
       },
     ],
-    "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
+    "version": 42, # Version of the `Policy`. The default version is 0.
     "etag": "A String", # Can be used to perform a read-modify-write.
   }
@@ -193,14 +193,14 @@

Method Details

Args: project: string, The name of the cloud project that topics belong to. (required) pageSize: integer, Maximum number of topics to return. - pageToken: string, The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data. + pageToken: string, The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Returns: An object of the form: - { # Response for the ListTopics method. - "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest. + { # Response for the `ListTopics` method. + "nextPageToken": "A String", # If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`. "topics": [ # The resulting topics. { # A topic resource. "name": "A String", # The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. @@ -225,7 +225,7 @@

Method Details

publish(topic, body, x__xgafv=None) -
Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
+  
Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
 
 Args:
   topic: string, The messages in the request will be published on this topic. (required)
@@ -239,7 +239,8 @@ 

Method Details

"a_key": "A String", }, "data": "A String", # The message payload. For JSON requests, the value of this field must be base64-encoded. - "messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call. + "publishTime": "A String", # The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. + "messageId": "A String", # ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. }, ], } @@ -249,7 +250,7 @@

Method Details

Returns: An object of the form: - { # Response for the Publish method. + { # Response for the `Publish` method. "messageIds": [ # The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic. "A String", ], @@ -261,21 +262,21 @@

Method Details

Sets the access control policy on the specified resource. Replaces any existing policy.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy is being specified. Resource is usually specified as a path, such as, projects/{project}/zones/{zone}/disks/{disk}. (required)
+  resource: string, 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. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `SetIamPolicy` method.
-    "policy": { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.
-      "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members.
-        { # Associates members with roles. See below for allowed formats of members.
-          "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required
-          "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com
+    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
+      "bindings": [ # 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.
+        { # Associates `members` with a `role`.
+          "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
+          "members": [ # 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`.
             "A String",
           ],
         },
       ],
-      "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0.
+      "version": 42, # Version of the `Policy`. The default version is 0.
       "etag": "A String", # Can be used to perform a read-modify-write.
     },
   }
@@ -285,16 +286,16 @@ 

Method Details

Returns: An object of the form: - { # # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ``` - "bindings": [ # It is an error to specify multiple bindings for the same role. It is an error to specify a binding with no members. - { # Associates members with roles. See below for allowed formats of members. - "role": "A String", # The name of the role to which the members should be bound. Examples: "roles/viewer", "roles/editor", "roles/owner". Required - "members": [ # Format of member entries: 1. allUsers Matches any requesting principal (users, service accounts or anonymous). 2. allAuthenticatedUsers Matches any requesting authenticated principal (users or service accounts). 3. user:{emailid} A google user account using an email address. For example alice@gmail.com, joe@example.com 4. serviceAccount:{emailid} An service account email. 5. group:{emailid} A google group with an email address. For example auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain name. For example google.com, example.com + { # 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). + "bindings": [ # 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. + { # Associates `members` with a `role`. + "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required + "members": [ # 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`. "A String", ], }, ], - "version": 42, # The policy language version. The version of the policy is represented by the etag. The default version is 0. + "version": 42, # Version of the `Policy`. The default version is 0. "etag": "A String", # Can be used to perform a read-modify-write. }
@@ -304,12 +305,12 @@

Method Details

Returns permissions that a caller has on the specified resource.
 
 Args:
-  resource: string, REQUIRED: The resource for which policy detail is being requested. Resource is usually specified as a path, such as, projects/{project}. (required)
+  resource: string, 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. (required)
   body: object, The request body. (required)
     The object takes the form of:
 
 { # Request message for `TestIamPermissions` method.
-    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
+    "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
       "A String",
     ],
   }
diff --git a/docs/dyn/pubsub_v1.projects.topics.subscriptions.html b/docs/dyn/pubsub_v1.projects.topics.subscriptions.html
index 8d8df4648b2..02b2b2f6c7d 100644
--- a/docs/dyn/pubsub_v1.projects.topics.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.topics.subscriptions.html
@@ -88,14 +88,14 @@ 

Method Details

Args: topic: string, The name of the topic that subscriptions are attached to. (required) pageSize: integer, Maximum number of subscription names to return. - pageToken: string, The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data. + pageToken: string, The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Returns: An object of the form: - { # Response for the ListTopicSubscriptions method. - "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions. + { # Response for the `ListTopicSubscriptions` method. + "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions. "subscriptions": [ # The names of the subscriptions that match the request. "A String", ], diff --git a/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html index 31b4ced40da..827cf29998e 100644 --- a/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html +++ b/docs/dyn/replicapoolupdater_v1beta1.rollingUpdates.html @@ -157,7 +157,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
@@ -307,7 +307,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
@@ -497,7 +497,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
@@ -554,7 +554,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
@@ -611,7 +611,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
diff --git a/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html b/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html index 82b17ad8831..d7a7d42ab72 100644 --- a/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html +++ b/docs/dyn/replicapoolupdater_v1beta1.zoneOperations.html @@ -136,7 +136,7 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }
@@ -198,13 +198,13 @@

Method Details

], }, "endTime": "A String", - "selfLink": "A String", # [Output Only] Server defined URL for the resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating. }, ], - "kind": "replicapoolupdater#operationList", # [Output Only] Type of resource. Always replicapoolupdater#operations for Operations resource. + "kind": "replicapoolupdater#operationList", # [Output Only] Type of resource. Always replicapoolupdater#operationList for OperationList resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. - "selfLink": "A String", # [Output Only] Server-defined URL for this resource. + "selfLink": "A String", # [Output Only] The fully qualified URL for the resource. }
diff --git a/docs/dyn/reseller_v1.customers.html b/docs/dyn/reseller_v1.customers.html index 8f9e31e5ec0..b2c135d4ece 100644 --- a/docs/dyn/reseller_v1.customers.html +++ b/docs/dyn/reseller_v1.customers.html @@ -99,6 +99,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -129,6 +130,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -148,13 +150,14 @@

Method Details

"customerId": "A String", # The id of the customer. } - customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional. + customerAuthToken: string, An auth token needed for inserting a customer for which domain already exists. Can be generated at https://admin.google.com/TransferToken. Optional. Returns: An object of the form: { # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -186,6 +189,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -211,6 +215,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -242,6 +247,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. @@ -267,6 +273,7 @@

Method Details

{ # JSON template for a customer. "customerDomain": "A String", # The domain name of the customer. + "customerDomainVerified": True or False, # Whether the customer's primary domain has been verified. "alternateEmail": "A String", # The alternate email of the customer. "kind": "reseller#customer", # Identifies the resource as a customer. "resourceUiUrl": "A String", # Ui url for customer resource. diff --git a/docs/dyn/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html index 47b0b2ede0b..a1b40037e4f 100644 --- a/docs/dyn/reseller_v1.subscriptions.html +++ b/docs/dyn/reseller_v1.subscriptions.html @@ -130,7 +130,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -198,7 +203,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -259,7 +269,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -322,7 +337,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -391,7 +411,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -442,7 +467,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -488,7 +518,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -548,7 +583,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -617,7 +657,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. @@ -670,7 +715,12 @@

Method Details

"trialEndTime": "A String", # End time of the trial in milliseconds since Unix epoch. "isInTrial": True or False, # Whether the subscription is in trial. }, - "suspensionReasons": [ # Suspension Reasons + "suspensionReasons": [ # 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: + # - PENDING_TOS_ACCEPTANCE — The customer has not logged in and accepted the Google Apps Resold Terms of Services. + # - RENEWAL_WITH_TYPE_CANCEL — The customer's commitment ended and their service was cancelled at the end of their term. + # - RESELLER_INITIATED — A manual suspension invoked by a Reseller. + # - TRIAL_ENDED — The customer's trial expired without a plan selected. + # - OTHER — The customer is suspended for an internal Google reason (e.g. abuse or otherwise). "A String", ], "resourceUiUrl": "A String", # Ui url for subscription resource. diff --git a/docs/dyn/script_v1.html b/docs/dyn/script_v1.html new file mode 100644 index 00000000000..c85c91b5ae2 --- /dev/null +++ b/docs/dyn/script_v1.html @@ -0,0 +1,103 @@ + + + +

Google Apps Script Execution API

+

Instance Methods

+

+ scripts() +

+

Returns the scripts Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/script_v1.scripts.html b/docs/dyn/script_v1.scripts.html new file mode 100644 index 00000000000..00880c9139c --- /dev/null +++ b/docs/dyn/script_v1.scripts.html @@ -0,0 +1,130 @@ + + + +

Google Apps Script Execution API . scripts

+

Instance Methods

+

+ run(scriptId, body, x__xgafv=None)

+

Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authentication](#authentication) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.

+

Method Details

+
+ run(scriptId, body, x__xgafv=None) +
Runs a function in an Apps Script project that has been deployed for use with the Apps Script Execution API. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authentication](#authentication) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab.
+
+Args:
+  scriptId: string, The project key of the script to be executed. To find the project key, open the project in the script editor, then select **File > Project properties**. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A request to run the function in a script. The script is identified by the specified `script_id`. Executing a function on a script will return results based on the implementation of the script.
+    "function": "A String", # The name of the function to execute in the given script. The name does not include parentheses or parameters.
+    "devMode": True or False, # If `true` and the user is an owner of the script, the script runs at the most recently saved version rather than the version deployed for use with the Execution API. Optional; default is `false`.
+    "parameters": [ # The parameters to be passed to the function being executed. The type for each parameter should match the expected type in Apps Script. Parameters cannot be Apps Script-specific objects (such as a `Document` or `Calendar`); they can only be primitive types such as a `string`, `number`, `array`, `object`, or `boolean`. Optional.
+      "",
+    ],
+    "sessionState": "A String", # This field is not used.
+  }
+
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # The response will not arrive until the function finishes executing. The maximum runtime is listed in the guide to [limitations in Apps Script](https://developers.google.com/apps-script/guides/services/quotas#current_limitations).
+      # If the script function returns successfully, the `response` field will contain an `ExecutionResponse` object with the function's return value in the object's `result` field.
+      #
+      # If the script function (or Apps Script itself) throws an exception, the `error` field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.
+      #
+      # If the `run` call itself fails (for example, because of a malformed request or an authorization error), the method will return an HTTP response code in the 4XX range with a different format for the response body. Client libraries will automatically convert a 4XX response into an exception class.
+    "response": { # If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+    "error": { # If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object. # If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field will contain a `Status` object. The `Status` object's `details` field will contain an array with a single `ExecutionError` object that provides information about the nature of the error.
+      "message": "A String", # 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.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # An array that contains a single `ExecutionError` object that provides information about the nature of the error.
+        {
+          "a_key": "", # Properties of the object. Contains field @ype with type URL.
+        },
+      ],
+    },
+    "done": True or False, # This field is not used.
+    "name": "A String", # This field is not used.
+    "metadata": { # This field is not used.
+      "a_key": "", # Properties of the object. Contains field @ype with type URL.
+    },
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/serviceregistry_alpha.endpoints.html b/docs/dyn/serviceregistry_alpha.endpoints.html new file mode 100644 index 00000000000..9d06ca78e56 --- /dev/null +++ b/docs/dyn/serviceregistry_alpha.endpoints.html @@ -0,0 +1,497 @@ + + + +

Google Cloud Service Registry API V1 . endpoints

+

Instance Methods

+

+ delete(project, endpoint)

+

Deletes an endpoint.

+

+ get(project, endpoint)

+

Gets an endpoint.

+

+ insert(project, body)

+

Creates an endpoint.

+

+ list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

+

Lists endpoints for a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ patch(project, endpoint, body)

+

Updates an endpoint. This method supports patch semantics.

+

+ update(project, endpoint, body)

+

Updates an endpoint.

+

Method Details

+
+ delete(project, endpoint) +
Deletes an endpoint.
+
+Args:
+  project: string, The project ID for this request. (required)
+  endpoint: string, The name of the endpoint for this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+  }
+
+ +
+ get(project, endpoint) +
Gets an endpoint.
+
+Args:
+  project: string, The project ID for this request. (required)
+  endpoint: string, The name of the endpoint for this request. (required)
+
+Returns:
+  An object of the form:
+
+    {
+      "description": "A String", # An optional user-provided description of the endpoint.
+      "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
+      "visibility": { # The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
+        "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
+          "A String",
+        ],
+        "projects": [ # Google Cloud projects for which the name of this endpoint should be resolvable through DNS.
+          "A String",
+        ],
+      },
+      "port": 42, # An optional user-provided port of the service represented by this endpoint.
+      "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
+      "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+      "selfLink": "A String", # [Output Only] Self link for the endpoint.
+      "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name 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.
+    }
+
+ +
+ insert(project, body) +
Creates an endpoint.
+
+Args:
+  project: string, The project ID for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "description": "A String", # An optional user-provided description of the endpoint.
+    "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
+    "visibility": { # The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
+      "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+      "projects": [ # Google Cloud projects for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+    },
+    "port": 42, # An optional user-provided port of the service represented by this endpoint.
+    "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
+    "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "selfLink": "A String", # [Output Only] Self link for the endpoint.
+    "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+  }
+
+ +
+ list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) +
Lists endpoints for a project.
+
+Args:
+  project: string, The project ID for this request. (required)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+  maxResults: integer, The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # A response containing a partial list of Endpoints and a page token used to build the next request if the request has been truncated. Next available tag: 5
+    "nextPageToken": "A String", # [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.
+    "endpoints": [ # The endpoints contained in this response.
+      {
+          "description": "A String", # An optional user-provided description of the endpoint.
+          "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
+          "visibility": { # The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
+            "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
+              "A String",
+            ],
+            "projects": [ # Google Cloud projects for which the name of this endpoint should be resolvable through DNS.
+              "A String",
+            ],
+          },
+          "port": 42, # An optional user-provided port of the service represented by this endpoint.
+          "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
+          "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+          "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+          "selfLink": "A String", # [Output Only] Self link for the endpoint.
+          "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name 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.
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ +
+ patch(project, endpoint, body) +
Updates an endpoint. This method supports patch semantics.
+
+Args:
+  project: string, The project ID for this request. (required)
+  endpoint: string, The name of the endpoint for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "description": "A String", # An optional user-provided description of the endpoint.
+    "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
+    "visibility": { # The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
+      "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+      "projects": [ # Google Cloud projects for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+    },
+    "port": 42, # An optional user-provided port of the service represented by this endpoint.
+    "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
+    "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "selfLink": "A String", # [Output Only] Self link for the endpoint.
+    "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+  }
+
+ +
+ update(project, endpoint, body) +
Updates an endpoint.
+
+Args:
+  project: string, The project ID for this request. (required)
+  endpoint: string, The name of the endpoint for this request. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{
+    "description": "A String", # An optional user-provided description of the endpoint.
+    "address": "A String", # A user-provided address of the service represented by this endpoint. This can be an IPv4 or IPv6 address, or a hostname.
+    "visibility": { # The visibility of this endpoint. This must be a list of fully-qualified URLs to Compute Engine networks.
+      "networks": [ # Google Compute Engine networks for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+      "projects": [ # Google Cloud projects for which the name of this endpoint should be resolvable through DNS.
+        "A String",
+      ],
+    },
+    "port": 42, # An optional user-provided port of the service represented by this endpoint.
+    "state": "A String", # [Output Only] The current state of the endpoint, as determined by the system.
+    "fingerprint": "A String", # Supply the fingerprint value for update requests. The fingerprint value is generated by the server and ensures optimistic concurrency (so that only one update can be performed at a time). The fingerprint changes after each update.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+    "selfLink": "A String", # [Output Only] Self link for the endpoint.
+    "name": "A String", # A user-provided name of the endpoint, which must be unique within the project. The name 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.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/serviceregistry_alpha.html b/docs/dyn/serviceregistry_alpha.html new file mode 100644 index 00000000000..3e1e0ec6bd5 --- /dev/null +++ b/docs/dyn/serviceregistry_alpha.html @@ -0,0 +1,108 @@ + + + +

Google Cloud Service Registry API V1

+

Instance Methods

+

+ endpoints() +

+

Returns the endpoints Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/serviceregistry_alpha.operations.html b/docs/dyn/serviceregistry_alpha.operations.html new file mode 100644 index 00000000000..9a5de23b629 --- /dev/null +++ b/docs/dyn/serviceregistry_alpha.operations.html @@ -0,0 +1,237 @@ + + + +

Google Cloud Service Registry API V1 . operations

+

Instance Methods

+

+ get(project, operation)

+

Gets information about a specific operation.

+

+ list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)

+

Lists all operations for a project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(project, operation) +
Gets information about a specific operation.
+
+Args:
+  project: string, The project ID for this request. (required)
+  operation: string, The name of the operation for this request. (required)
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource, used to manage asynchronous API requests.
+    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+    "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+    "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+    "progress": 42, # [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.
+    "httpErrorStatusCode": 42, # [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.
+    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+      {
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+          {
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+            "key": "A String", # [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).
+          },
+        ],
+      },
+    ],
+    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+    "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+    "name": "A String", # [Output Only] Name of the resource.
+    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+        },
+      ],
+    },
+    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+    "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+  }
+
+ +
+ list(project, orderBy=None, maxResults=None, pageToken=None, filter=None) +
Lists all operations for a project.
+
+Args:
+  project: string, The project ID for this request. (required)
+  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by name or creationTimestamp desc is supported.
+  maxResults: integer, The maximum number of results per page that Compute Engine should return. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.
+  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
+  filter: string, 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.
+
+The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
+
+For example, filter=name ne example-instance.
+
+Compute 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.
+
+The 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.
+
+Returns:
+  An object of the form:
+
+    { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
+    "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+    "operations": [ # [Output Only] Operations contained in this list response.
+      { # An Operation resource, used to manage asynchronous API requests.
+        "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+        "clientOperationId": "A String", # [Output Only] A unique client ID generated by the server.
+        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
+        "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+        "operationType": "A String", # [Output Only] The type of operation, which can be insert, update, or delete.
+        "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+        "progress": 42, # [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.
+        "httpErrorStatusCode": 42, # [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.
+        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+        "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+        "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+        "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+          {
+            "message": "A String", # [Output Only] A human-readable description of the warning code.
+            "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+            "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+                # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+              {
+                "value": "A String", # [Output Only] A warning data value corresponding to the key.
+                "key": "A String", # [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).
+              },
+            ],
+          },
+        ],
+        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+        "kind": "serviceregistry#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
+        "name": "A String", # [Output Only] Name of the resource.
+        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
+        "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+            {
+              "message": "A String", # [Output Only] An optional, human-readable error message.
+              "code": "A String", # [Output Only] The error type identifier for this error.
+              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
+            },
+          ],
+        },
+        "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+        "targetLink": "A String", # [Output Only] The URL of the resource that the operation is modifying.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/sqladmin_v1beta4.backupRuns.html b/docs/dyn/sqladmin_v1beta4.backupRuns.html index fe2536382db..b9f5b58e840 100644 --- a/docs/dyn/sqladmin_v1beta4.backupRuns.html +++ b/docs/dyn/sqladmin_v1beta4.backupRuns.html @@ -94,7 +94,7 @@

Method Details

Args: project: string, Project ID of the project that contains the instance. (required) instance: string, Cloud SQL instance ID. This does not include the project ID. (required) - id: string, The ID of the Backup Run to delete. (required) + id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (required) Returns: An object of the form: @@ -133,7 +133,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/sqladmin_v1beta4.databases.html b/docs/dyn/sqladmin_v1beta4.databases.html index c16379cab59..8818509ed7b 100644 --- a/docs/dyn/sqladmin_v1beta4.databases.html +++ b/docs/dyn/sqladmin_v1beta4.databases.html @@ -139,7 +139,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -247,7 +247,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -360,7 +360,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -445,7 +445,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/sqladmin_v1beta4.flags.html b/docs/dyn/sqladmin_v1beta4.flags.html index 55c72c7073f..be539f98ccd 100644 --- a/docs/dyn/sqladmin_v1beta4.flags.html +++ b/docs/dyn/sqladmin_v1beta4.flags.html @@ -95,7 +95,8 @@

Method Details

"allowedStringValues": [ # For STRING flags, a list of strings that the value can be set to. "A String", ], - "appliesTo": [ # The database version this flag applies to. Currently this can only be [MYSQL_5_5]. + "requiresRestart": True or False, # Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. + "appliesTo": [ # The database version this flag applies to. Can be MYSQL_5_5, MYSQL_5_6, or both. "A String", ], "maxValue": "A String", # For INTEGER flags, the maximum allowed value. diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 68c71fad31d..0ddfa3c238b 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -83,6 +83,9 @@

Instance Methods

export(project, instance, body)

Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a MySQL dump file.

+

+ failover(project, instance, body)

+

Failover the instance to its failover replica instance.

get(project, instance)

Retrieves a resource containing information about a Cloud SQL instance.

@@ -183,7 +186,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -253,7 +256,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -305,9 +308,89 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. + }, + }, + } + + +Returns: + An object of the form: + + { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly. + "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN. + "importContext": { # Database instance import context. # The context for import operation, if applicable. + "fileType": "A String", # The file type for the specified uri. + # SQL: The file contains SQL statements. + # CSV: The file contains CSV data. + "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified. + "kind": "sql#importContext", # This is always sql#importContext. + "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL. + "csvImportOptions": { # Options for importing data as CSV. + "table": "A String", # The table to which CSV data is imported. + "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data. + "A String", + ], + }, + }, + "kind": "sql#operation", # This is always sql#operation. + "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. + "exportContext": { # Database instance export context. # The context for export operation, if applicable. + "kind": "sql#exportContext", # This is always sql#exportContext. + "fileType": "A String", # The file type for the specified uri. + # SQL: The file contains SQL statements. + # CSV: The file contains CSV data. + "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed. + "csvExportOptions": { # Options for exporting data as CSV. + "selectQuery": "A String", # The select query used to extract the data. + }, + "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored. + "A String", + ], + "sqlExportOptions": { # Options for exporting data as SQL statements. + "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. + "A String", + ], + "schemaOnly": True or False, # Export only schemas. }, }, + "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. + "targetProject": "A String", # The project ID of the target instance related to this operation. + "targetId": "A String", # Name of the database instance related to this operation. + "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE . + "targetLink": "A String", # The URI of the instance related to the operation. + "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. + "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated. + "kind": "sql#operationErrors", # This is always sql#operationErrors. + "errors": [ # The list of errors encountered while processing this operation. + { # Database instance operation error. + "kind": "sql#operationError", # This is always sql#operationError. + "code": "A String", # Identifies the specific error that occurred. + "message": "A String", # Additional information about the error encountered. + }, + ], + }, + "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. + "selfLink": "A String", # The URI of this resource. + "user": "A String", # The email address of the user who initiated this operation. + }
+
+ +
+ failover(project, instance, body) +
Failover the instance to its failover replica instance.
+
+Args:
+  project: string, ID of the project that contains the read replica. (required)
+  instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Instance failover request.
+    "failoverContext": { # Database instance failover context. # Failover Context.
+      "kind": "sql#failoverContext", # This is always sql#failoverContext.
+      "settingsVersion": "A String", # The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version.
+    },
   }
 
 
@@ -348,7 +431,7 @@ 

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -390,10 +473,15 @@

Method Details

"hostPort": "A String", # The host and port of the on-premises instance in host:port format }, "kind": "sql#instance", # This is always sql#instance. - "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "failoverReplica": { # The name and status of the failover replica. Only applies to Second Generation instances. + "available": True or False, + "name": "A String", + }, "ipv6Address": "A String", # The IPv6 address assigned to the instance. "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters. "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. + # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. "username": "A String", # The username for the replication connection. "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration. @@ -425,6 +513,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. }, "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. # RUNNABLE: The instance is running, or is ready to run when accessed. @@ -450,6 +539,13 @@

Method Details

}, ], "kind": "sql#settings", # This is always sql#settings. + "dataDiskType": "A String", # The type of data disk. Only supported for 2nd Generation instances. The default type is SSD. + "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. + "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow. + "updateTrack": "A String", + "day": 42, # day of week (1-7), starting on Monday. + "hour": 42, # hour of day - 0 to 23. + }, "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. "A String", ], @@ -486,13 +582,14 @@

Method Details

"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. }, + "dataDiskSizeGb": "A String", # The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB. }, "instanceType": "A String", # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. "selfLink": "A String", # The URI of this resource. - "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. }
@@ -561,7 +658,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -601,10 +698,15 @@

Method Details

"hostPort": "A String", # The host and port of the on-premises instance in host:port format }, "kind": "sql#instance", # This is always sql#instance. - "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "failoverReplica": { # The name and status of the failover replica. Only applies to Second Generation instances. + "available": True or False, + "name": "A String", + }, "ipv6Address": "A String", # The IPv6 address assigned to the instance. "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters. "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. + # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. "username": "A String", # The username for the replication connection. "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration. @@ -636,6 +738,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. }, "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. # RUNNABLE: The instance is running, or is ready to run when accessed. @@ -661,6 +764,13 @@

Method Details

}, ], "kind": "sql#settings", # This is always sql#settings. + "dataDiskType": "A String", # The type of data disk. Only supported for 2nd Generation instances. The default type is SSD. + "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. + "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow. + "updateTrack": "A String", + "day": 42, # day of week (1-7), starting on Monday. + "hour": 42, # hour of day - 0 to 23. + }, "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. "A String", ], @@ -697,13 +807,14 @@

Method Details

"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. }, + "dataDiskSizeGb": "A String", # The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB. }, "instanceType": "A String", # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. "selfLink": "A String", # The URI of this resource. - "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. } @@ -744,7 +855,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -790,10 +901,15 @@

Method Details

"hostPort": "A String", # The host and port of the on-premises instance in host:port format }, "kind": "sql#instance", # This is always sql#instance. - "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "failoverReplica": { # The name and status of the failover replica. Only applies to Second Generation instances. + "available": True or False, + "name": "A String", + }, "ipv6Address": "A String", # The IPv6 address assigned to the instance. "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters. "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. + # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. "username": "A String", # The username for the replication connection. "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration. @@ -825,6 +941,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. }, "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. # RUNNABLE: The instance is running, or is ready to run when accessed. @@ -850,6 +967,13 @@

Method Details

}, ], "kind": "sql#settings", # This is always sql#settings. + "dataDiskType": "A String", # The type of data disk. Only supported for 2nd Generation instances. The default type is SSD. + "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. + "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow. + "updateTrack": "A String", + "day": 42, # day of week (1-7), starting on Monday. + "hour": 42, # hour of day - 0 to 23. + }, "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. "A String", ], @@ -886,13 +1010,14 @@

Method Details

"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. }, + "dataDiskSizeGb": "A String", # The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB. }, "instanceType": "A String", # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. "selfLink": "A String", # The URI of this resource. - "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. }, ], "kind": "sql#instancesList", # This is always sql#instancesList. @@ -929,10 +1054,15 @@

Method Details

"hostPort": "A String", # The host and port of the on-premises instance in host:port format }, "kind": "sql#instance", # This is always sql#instance. - "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "failoverReplica": { # The name and status of the failover replica. Only applies to Second Generation instances. + "available": True or False, + "name": "A String", + }, "ipv6Address": "A String", # The IPv6 address assigned to the instance. "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters. "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. + # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. "username": "A String", # The username for the replication connection. "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration. @@ -964,6 +1094,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. }, "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. # RUNNABLE: The instance is running, or is ready to run when accessed. @@ -989,6 +1120,13 @@

Method Details

}, ], "kind": "sql#settings", # This is always sql#settings. + "dataDiskType": "A String", # The type of data disk. Only supported for 2nd Generation instances. The default type is SSD. + "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. + "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow. + "updateTrack": "A String", + "day": 42, # day of week (1-7), starting on Monday. + "hour": 42, # hour of day - 0 to 23. + }, "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. "A String", ], @@ -1025,13 +1163,14 @@

Method Details

"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. }, + "dataDiskSizeGb": "A String", # The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB. }, "instanceType": "A String", # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. "selfLink": "A String", # The URI of this resource. - "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. } @@ -1072,7 +1211,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1142,7 +1281,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1212,7 +1351,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1282,7 +1421,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1363,7 +1502,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1433,7 +1572,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1503,7 +1642,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -1544,10 +1683,15 @@

Method Details

"hostPort": "A String", # The host and port of the on-premises instance in host:port format }, "kind": "sql#instance", # This is always sql#instance. - "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. + "failoverReplica": { # The name and status of the failover replica. Only applies to Second Generation instances. + "available": True or False, + "name": "A String", + }, "ipv6Address": "A String", # The IPv6 address assigned to the instance. "replicaConfiguration": { # Read-replica configuration for connecting to the master. # Configuration specific to read-replicas replicating from on-premises masters. "kind": "sql#replicaConfiguration", # This is always sql#replicaConfiguration. + "failoverTarget": True or False, # Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. In case the master instance fails, the replica instance will be promoted as the new master instance. + # Only one replica can be specified as failover target, and the replica has to be in different zone with the master instance. "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises master. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata. The configuration information is used only to set up the replication connection and is stored by MySQL in a file named master.info in the data directory. "username": "A String", # The username for the replication connection. "kind": "sql#mysqlReplicaConfiguration", # This is always sql#mysqlReplicaConfiguration. @@ -1579,6 +1723,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. }, "masterInstanceName": "A String", # The name of the instance which will act as master in the replication setup. + "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. "currentDiskSize": "A String", # The current disk usage of the instance in bytes. "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. # RUNNABLE: The instance is running, or is ready to run when accessed. @@ -1604,6 +1749,13 @@

Method Details

}, ], "kind": "sql#settings", # This is always sql#settings. + "dataDiskType": "A String", # The type of data disk. Only supported for 2nd Generation instances. The default type is SSD. + "maintenanceWindow": { # Maintenance window. This specifies when a v2 Cloud SQL instance should preferably be restarted for system maintenance puruposes. # The maintenance window for this instance. This specifies when the instance may be restarted for maintenance purposes. + "kind": "sql#maintenanceWindow", # This is always sql#maintenanceWindow. + "updateTrack": "A String", + "day": 42, # day of week (1-7), starting on Monday. + "hour": 42, # hour of day - 0 to 23. + }, "authorizedGaeApplications": [ # The App Engine app IDs that can access this instance. "A String", ], @@ -1640,13 +1792,14 @@

Method Details

"zone": "A String", # The preferred Compute Engine zone (e.g. us-centra1-a, us-central1-b, etc.). "followGaeApplication": "A String", # The AppEngine application to follow, it must be in the same region as the Cloud SQL instance. }, + "dataDiskSizeGb": "A String", # The size of data disk, in GB. Only supported for 2nd Generation instances. The data disk size minimum is 10GB. }, "instanceType": "A String", # The instance type. This can be one of the following. # CLOUD_SQL_INSTANCE: A Cloud SQL instance that is not replicating from a master. # ON_PREMISES_INSTANCE: An instance running on the customer's premises. # READ_REPLICA_INSTANCE: A Cloud SQL instance configured as a read-replica. "selfLink": "A String", # The URI of this resource. - "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID. + "maxDiskSize": "A String", # The maximum disk size of the instance in bytes. } @@ -1687,7 +1840,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/sqladmin_v1beta4.operations.html b/docs/dyn/sqladmin_v1beta4.operations.html index fbda87fecb6..8b19636bfed 100644 --- a/docs/dyn/sqladmin_v1beta4.operations.html +++ b/docs/dyn/sqladmin_v1beta4.operations.html @@ -129,7 +129,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -204,7 +204,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/sqladmin_v1beta4.sslCerts.html b/docs/dyn/sqladmin_v1beta4.sslCerts.html index 36d24dc1907..ec1385dab5b 100644 --- a/docs/dyn/sqladmin_v1beta4.sslCerts.html +++ b/docs/dyn/sqladmin_v1beta4.sslCerts.html @@ -167,7 +167,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html index 70f03c546ae..1a676d61247 100644 --- a/docs/dyn/sqladmin_v1beta4.users.html +++ b/docs/dyn/sqladmin_v1beta4.users.html @@ -134,7 +134,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -217,7 +217,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. @@ -330,7 +330,7 @@

Method Details

"tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. "A String", ], - "schemaOnly": True or False, # Export only schema. + "schemaOnly": True or False, # Export only schemas. }, }, "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. diff --git a/docs/dyn/storage_v1.bucketAccessControls.html b/docs/dyn/storage_v1.bucketAccessControls.html index 870beb6ccb1..8d142f62cf7 100644 --- a/docs/dyn/storage_v1.bucketAccessControls.html +++ b/docs/dyn/storage_v1.bucketAccessControls.html @@ -72,7 +72,7 @@ -

Cloud Storage API . bucketAccessControls

+

Cloud Storage JSON API . bucketAccessControls

Instance Methods

delete(bucket, entity)

diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html index f70717f7c03..f117eef7a34 100644 --- a/docs/dyn/storage_v1.buckets.html +++ b/docs/dyn/storage_v1.buckets.html @@ -72,7 +72,7 @@ -

Cloud Storage API . buckets

+

Cloud Storage JSON API . buckets

Instance Methods

delete(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)

@@ -136,7 +136,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -263,7 +264,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -403,7 +405,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -541,7 +544,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -685,7 +689,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -827,7 +832,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -954,7 +960,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, @@ -1096,7 +1103,8 @@

Method Details

}, "name": "A String", # The name of the bucket. "metageneration": "A String", # The metadata generation of this bucket. - "timeCreated": "A String", # Creation time of the bucket in RFC 3339 format. + "timeCreated": "A String", # The creation time of the bucket in RFC 3339 format. + "updated": "A String", # The modification time of the bucket in RFC 3339 format. "versioning": { # The bucket's versioning configuration. "enabled": True or False, # While set to true, versioning is fully enabled for this bucket. }, diff --git a/docs/dyn/storage_v1.channels.html b/docs/dyn/storage_v1.channels.html index e3b07e75152..0bb67c5bd39 100644 --- a/docs/dyn/storage_v1.channels.html +++ b/docs/dyn/storage_v1.channels.html @@ -72,7 +72,7 @@ -

Cloud Storage API . channels

+

Cloud Storage JSON API . channels

Instance Methods

stop(body)

diff --git a/docs/dyn/storage_v1.defaultObjectAccessControls.html b/docs/dyn/storage_v1.defaultObjectAccessControls.html index 335161c79db..5dccbfc4b7e 100644 --- a/docs/dyn/storage_v1.defaultObjectAccessControls.html +++ b/docs/dyn/storage_v1.defaultObjectAccessControls.html @@ -72,7 +72,7 @@ -

Cloud Storage API . defaultObjectAccessControls

+

Cloud Storage JSON API . defaultObjectAccessControls

Instance Methods

delete(bucket, entity)

diff --git a/docs/dyn/storage_v1.html b/docs/dyn/storage_v1.html index 04ddbc913e4..d8ad463204a 100644 --- a/docs/dyn/storage_v1.html +++ b/docs/dyn/storage_v1.html @@ -72,7 +72,7 @@ -

Cloud Storage API

+

Cloud Storage JSON API

Instance Methods

bucketAccessControls() diff --git a/docs/dyn/storage_v1.objectAccessControls.html b/docs/dyn/storage_v1.objectAccessControls.html index 5f2473546fd..75f4c8a79d3 100644 --- a/docs/dyn/storage_v1.objectAccessControls.html +++ b/docs/dyn/storage_v1.objectAccessControls.html @@ -72,7 +72,7 @@ -

Cloud Storage API . objectAccessControls

+

Cloud Storage JSON API . objectAccessControls

Instance Methods

delete(bucket, object, entity, generation=None)

diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html index 33e1f43fbb2..63297ad79f3 100644 --- a/docs/dyn/storage_v1.objects.html +++ b/docs/dyn/storage_v1.objects.html @@ -72,7 +72,7 @@ -

Cloud Storage API . objects

+

Cloud Storage JSON API . objects

Instance Methods

compose(destinationBucket, destinationObject, body, ifGenerationMatch=None, ifMetagenerationMatch=None, destinationPredefinedAcl=None)

@@ -178,23 +178,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }, "sourceObjects": [ # The list of source objects that will be concatenated into a single object. { @@ -264,23 +269,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -339,23 +349,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }, "sourceObjects": [ # The list of source objects that will be concatenated into a single object. { @@ -440,23 +455,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @@ -527,23 +547,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -602,23 +627,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @@ -727,23 +757,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -822,23 +857,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @@ -907,23 +947,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -979,23 +1024,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @@ -1089,23 +1139,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }, ], "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects. @@ -1182,23 +1237,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. @@ -1265,23 +1325,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -1340,23 +1405,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } projection: string, Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @@ -1432,23 +1502,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }, "done": True or False, # true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response. "totalBytesRewritten": "A String", # The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response. @@ -1509,23 +1584,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. @@ -1592,23 +1672,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. }
@@ -1665,23 +1750,28 @@

Method Details

"id": "A String", # The ID of the object. "size": "A String", # Content-Length of the data in bytes. "timeDeleted": "A String", # The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + "timeCreated": "A String", # The creation time of the object in RFC 3339 format. "md5Hash": "A String", # MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. "crc32c": "A String", # CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. "etag": "A String", # HTTP 1.1 Entity tag for the object. "metadata": { # User-provided metadata, in key/value pairs. "a_key": "A String", # An individual metadata entry. }, - "updated": "A String", # The creation or modification time of the object in RFC 3339 format. For buckets with versioning enabled, changing an object's metadata does not change this property. + "updated": "A String", # The modification time of the object metadata in RFC 3339 format. "contentType": "A String", # Content-Type of the object data. - "contentDisposition": "A String", # Content-Disposition of the object data. "contentLanguage": "A String", # Content-Language of the object data. + "customerEncryption": { # Metadata of customer-supplied encryption key, if the object is encrypted by such a key. + "encryptionAlgorithm": "A String", # The encryption algorithm. + "keySha256": "A String", # SHA256 hash value of the encryption key. + }, "metageneration": "A String", # The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. "kind": "storage#object", # The kind of item this is. For objects, this is always storage#object. "name": "A String", # The name of this object. Required if not specified by URL parameter. "bucket": "A String", # The name of the bucket containing this object. "contentEncoding": "A String", # Content-Encoding of the object data. - "storageClass": "A String", # Storage class of the object. + "contentDisposition": "A String", # Content-Disposition of the object data. "selfLink": "A String", # The link to this object. + "storageClass": "A String", # Storage class of the object. } ifGenerationMatch: string, Makes the operation conditional on whether the object's current generation matches the given value. diff --git a/docs/dyn/tagmanager_v1.accounts.containers.environments.html b/docs/dyn/tagmanager_v1.accounts.containers.environments.html new file mode 100644 index 00000000000..c400f8dff50 --- /dev/null +++ b/docs/dyn/tagmanager_v1.accounts.containers.environments.html @@ -0,0 +1,305 @@ + + + +

Tag Manager API . accounts . containers . environments

+

Instance Methods

+

+ create(accountId, containerId, body)

+

Creates a GTM Environment.

+

+ delete(accountId, containerId, environmentId)

+

Deletes a GTM Environment.

+

+ get(accountId, containerId, environmentId)

+

Gets a GTM Environment.

+

+ list(accountId, containerId)

+

Lists all GTM Environments of a GTM Container.

+

+ patch(accountId, containerId, environmentId, body, fingerprint=None)

+

Updates a GTM Environment. This method supports patch semantics.

+

+ update(accountId, containerId, environmentId, body, fingerprint=None)

+

Updates a GTM Environment.

+

Method Details

+
+ create(accountId, containerId, body) +
Creates a GTM Environment.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+  "authorizationCode": "A String", # The environment authorization code.
+  "containerId": "A String", # GTM Container ID.
+  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+  "url": "A String", # Default preview page url for the environment.
+  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+  "containerVersionId": "A String",
+  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+  "accountId": "A String", # GTM Account ID.
+  "type": "A String", # The type of this environment.
+  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+    "authorizationCode": "A String", # The environment authorization code.
+    "containerId": "A String", # GTM Container ID.
+    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+    "url": "A String", # Default preview page url for the environment.
+    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+    "containerVersionId": "A String",
+    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+    "accountId": "A String", # GTM Account ID.
+    "type": "A String", # The type of this environment.
+    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+  }
+
+ +
+ delete(accountId, containerId, environmentId) +
Deletes a GTM Environment.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  environmentId: string, The GTM Environment ID. (required)
+
+
+ +
+ get(accountId, containerId, environmentId) +
Gets a GTM Environment.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  environmentId: string, The GTM Environment ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+    "authorizationCode": "A String", # The environment authorization code.
+    "containerId": "A String", # GTM Container ID.
+    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+    "url": "A String", # Default preview page url for the environment.
+    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+    "containerVersionId": "A String",
+    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+    "accountId": "A String", # GTM Account ID.
+    "type": "A String", # The type of this environment.
+    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+  }
+
+ +
+ list(accountId, containerId) +
Lists all GTM Environments of a GTM Container.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+
+Returns:
+  An object of the form:
+
+    { # List Environments Response.
+    "environments": [ # All Environments of a GTM Container.
+      { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+        "authorizationCode": "A String", # The environment authorization code.
+        "containerId": "A String", # GTM Container ID.
+        "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+        "url": "A String", # Default preview page url for the environment.
+        "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+        "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+        "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+        "containerVersionId": "A String",
+        "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+        "accountId": "A String", # GTM Account ID.
+        "type": "A String", # The type of this environment.
+        "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+      },
+    ],
+  }
+
+ +
+ patch(accountId, containerId, environmentId, body, fingerprint=None) +
Updates a GTM Environment. This method supports patch semantics.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  environmentId: string, The GTM Environment ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+  "authorizationCode": "A String", # The environment authorization code.
+  "containerId": "A String", # GTM Container ID.
+  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+  "url": "A String", # Default preview page url for the environment.
+  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+  "containerVersionId": "A String",
+  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+  "accountId": "A String", # GTM Account ID.
+  "type": "A String", # The type of this environment.
+  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+}
+
+  fingerprint: string, When provided, this fingerprint must match the fingerprint of the environment in storage.
+
+Returns:
+  An object of the form:
+
+    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+    "authorizationCode": "A String", # The environment authorization code.
+    "containerId": "A String", # GTM Container ID.
+    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+    "url": "A String", # Default preview page url for the environment.
+    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+    "containerVersionId": "A String",
+    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+    "accountId": "A String", # GTM Account ID.
+    "type": "A String", # The type of this environment.
+    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+  }
+
+ +
+ update(accountId, containerId, environmentId, body, fingerprint=None) +
Updates a GTM Environment.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  environmentId: string, The GTM Environment ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+  "authorizationCode": "A String", # The environment authorization code.
+  "containerId": "A String", # GTM Container ID.
+  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+  "url": "A String", # Default preview page url for the environment.
+  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+  "containerVersionId": "A String",
+  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+  "accountId": "A String", # GTM Account ID.
+  "type": "A String", # The type of this environment.
+  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+}
+
+  fingerprint: string, When provided, this fingerprint must match the fingerprint of the environment in storage.
+
+Returns:
+  An object of the form:
+
+    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+    "authorizationCode": "A String", # The environment authorization code.
+    "containerId": "A String", # GTM Container ID.
+    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+    "url": "A String", # Default preview page url for the environment.
+    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+    "containerVersionId": "A String",
+    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+    "accountId": "A String", # GTM Account ID.
+    "type": "A String", # The type of this environment.
+    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/tagmanager_v1.accounts.containers.folders.entities.html b/docs/dyn/tagmanager_v1.accounts.containers.folders.entities.html index 8a766fd0266..46ec77ded36 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.folders.entities.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.folders.entities.html @@ -112,14 +112,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -136,7 +136,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -146,14 +146,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -165,14 +165,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -181,14 +181,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -197,14 +197,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -215,14 +215,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -233,21 +233,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -257,14 +257,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -276,14 +276,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -292,14 +292,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -308,14 +308,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -323,7 +323,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -333,14 +333,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -353,14 +353,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -383,14 +383,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -417,14 +417,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. diff --git a/docs/dyn/tagmanager_v1.accounts.containers.html b/docs/dyn/tagmanager_v1.accounts.containers.html index 6605069fccc..3fbf5588a36 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.html @@ -75,14 +75,14 @@

Tag Manager API . accounts . containers

Instance Methods

- folders() + environments()

-

Returns the folders Resource.

+

Returns the environments Resource.

- macros() + folders()

-

Returns the macros Resource.

+

Returns the folders Resource.

move_folders() @@ -90,9 +90,9 @@

Instance Methods

Returns the move_folders Resource.

- rules() + reauthorize_environments()

-

Returns the rules Resource.

+

Returns the reauthorize_environments Resource.

tags() diff --git a/docs/dyn/tagmanager_v1.accounts.containers.move_folders.html b/docs/dyn/tagmanager_v1.accounts.containers.move_folders.html index 7f99bc12b39..5835ec7c042 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.move_folders.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.move_folders.html @@ -75,17 +75,28 @@

Tag Manager API . accounts . containers . move_folders

Instance Methods

- update(accountId, containerId, folderId, variableId=None, tagId=None, triggerId=None)

+ update(accountId, containerId, folderId, body, variableId=None, tagId=None, triggerId=None)

Moves entities to a GTM Folder.

Method Details

- update(accountId, containerId, folderId, variableId=None, tagId=None, triggerId=None) + update(accountId, containerId, folderId, body, variableId=None, tagId=None, triggerId=None)
Moves entities to a GTM Folder.
 
 Args:
   accountId: string, The GTM Account ID. (required)
   containerId: string, The GTM Container ID. (required)
   folderId: string, The GTM Folder ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Google Tag Manager Folder.
+    "folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
+    "fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
+    "containerId": "A String", # GTM Container ID.
+    "name": "A String", # Folder display name.
+    "accountId": "A String", # GTM Account ID.
+  }
+
   variableId: string, The variables to be moved to the folder. (repeated)
   tagId: string, The tags to be moved to the folder. (repeated)
   triggerId: string, The triggers to be moved to the folder. (repeated)
diff --git a/docs/dyn/tagmanager_v1.accounts.containers.reauthorize_environments.html b/docs/dyn/tagmanager_v1.accounts.containers.reauthorize_environments.html
new file mode 100644
index 00000000000..6de8cb0939f
--- /dev/null
+++ b/docs/dyn/tagmanager_v1.accounts.containers.reauthorize_environments.html
@@ -0,0 +1,127 @@
+
+
+
+

Tag Manager API . accounts . containers . reauthorize_environments

+

Instance Methods

+

+ update(accountId, containerId, environmentId, body)

+

Re-generates the authorization code for a GTM Environment.

+

Method Details

+
+ update(accountId, containerId, environmentId, body) +
Re-generates the authorization code for a GTM Environment.
+
+Args:
+  accountId: string, The GTM Account ID. (required)
+  containerId: string, The GTM Container ID. (required)
+  environmentId: string, The GTM Environment ID. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+  "authorizationCode": "A String", # The environment authorization code.
+  "containerId": "A String", # GTM Container ID.
+  "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+  "url": "A String", # Default preview page url for the environment.
+  "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+  "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+  "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+  "containerVersionId": "A String",
+  "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+  "accountId": "A String", # GTM Account ID.
+  "type": "A String", # The type of this environment.
+  "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
+    "authorizationCode": "A String", # The environment authorization code.
+    "containerId": "A String", # GTM Container ID.
+    "environmentId": "A String", # GTM Environment ID uniquely identifies the GTM Environment.
+    "url": "A String", # Default preview page url for the environment.
+    "name": "A String", # The environment display name. Can be set or changed only on USER type environments.
+    "enableDebug": True or False, # Whether or not to enable debug by default on for the environment.
+    "authorizationTimestampMs": "A String", # The last update time-stamp for the authorization code.
+    "containerVersionId": "A String",
+    "fingerprint": "A String", # The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
+    "accountId": "A String", # GTM Account ID.
+    "type": "A String", # The type of this environment.
+    "description": "A String", # The environment description. Can be set or changed only on USER type environments.
+  }
+
+ + \ No newline at end of file diff --git a/docs/dyn/tagmanager_v1.accounts.containers.tags.html b/docs/dyn/tagmanager_v1.accounts.containers.tags.html index 2504fe63323..1c15fd28e3d 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.tags.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.tags.html @@ -117,14 +117,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -151,14 +151,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -194,14 +194,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -228,14 +228,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -291,14 +291,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -325,14 +325,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -378,14 +378,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -412,14 +412,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -465,14 +465,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -499,14 +499,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -543,14 +543,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -577,14 +577,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. diff --git a/docs/dyn/tagmanager_v1.accounts.containers.triggers.html b/docs/dyn/tagmanager_v1.accounts.containers.triggers.html index ff800bffcbc..9cacb0dc5dc 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.triggers.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.triggers.html @@ -106,7 +106,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -116,14 +116,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -135,14 +135,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -151,14 +151,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -167,14 +167,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -185,14 +185,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -203,21 +203,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -227,14 +227,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -246,14 +246,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -262,14 +262,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -278,14 +278,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -293,7 +293,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -303,14 +303,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -323,14 +323,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. } @@ -345,7 +345,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -355,14 +355,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -374,14 +374,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -390,14 +390,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -406,14 +406,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -424,14 +424,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -442,21 +442,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -466,14 +466,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -485,14 +485,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -501,14 +501,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -517,14 +517,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -532,7 +532,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -542,14 +542,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -562,14 +562,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }
@@ -604,7 +604,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -614,14 +614,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -633,14 +633,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -649,14 +649,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -665,14 +665,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -683,14 +683,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -701,21 +701,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -725,14 +725,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -744,14 +744,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -760,14 +760,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -776,14 +776,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -791,7 +791,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -801,14 +801,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -821,14 +821,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }
@@ -853,7 +853,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -863,14 +863,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -882,14 +882,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -898,14 +898,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -914,14 +914,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -932,14 +932,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -950,21 +950,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -974,14 +974,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -993,14 +993,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1009,14 +1009,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1025,14 +1025,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1040,7 +1040,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1050,14 +1050,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1070,14 +1070,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -1102,7 +1102,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1112,14 +1112,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1131,14 +1131,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1147,14 +1147,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1163,14 +1163,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -1181,14 +1181,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -1199,21 +1199,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1223,14 +1223,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1242,14 +1242,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1258,14 +1258,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1274,14 +1274,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1289,7 +1289,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1299,14 +1299,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1319,14 +1319,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. } @@ -1342,7 +1342,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1352,14 +1352,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1371,14 +1371,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1387,14 +1387,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1403,14 +1403,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -1421,14 +1421,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -1439,21 +1439,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1463,14 +1463,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1482,14 +1482,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1498,14 +1498,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1514,14 +1514,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1529,7 +1529,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1539,14 +1539,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1559,14 +1559,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }
diff --git a/docs/dyn/tagmanager_v1.accounts.containers.variables.html b/docs/dyn/tagmanager_v1.accounts.containers.variables.html index b9fc291dff0..b5156fa50e5 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.variables.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.variables.html @@ -120,14 +120,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -161,14 +161,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -222,14 +222,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -273,14 +273,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -324,14 +324,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -366,14 +366,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. diff --git a/docs/dyn/tagmanager_v1.accounts.containers.versions.html b/docs/dyn/tagmanager_v1.accounts.containers.versions.html index 81b2fe8de20..6147dd1aad7 100644 --- a/docs/dyn/tagmanager_v1.accounts.containers.versions.html +++ b/docs/dyn/tagmanager_v1.accounts.containers.versions.html @@ -84,14 +84,14 @@

Instance Methods

get(accountId, containerId, containerVersionId)

Gets a Container Version.

- list(accountId, containerId, headers=None)

+ list(accountId, containerId, includeDeleted=None, headers=None)

Lists all Container Versions of a GTM Container.

publish(accountId, containerId, containerVersionId, fingerprint=None)

Publishes a Container Version.

restore(accountId, containerId, containerVersionId)

-

Restores a Container Version. This will overwrite the container's current configuration (including its macros, rules and tags). The operation will not have any effect on the version that is being served (i.e. the published version).

+

Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).

undelete(accountId, containerId, containerVersionId)

Undeletes a Container Version.

@@ -144,79 +144,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -237,14 +237,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -271,14 +271,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -316,14 +316,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -349,7 +349,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -359,14 +359,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -378,14 +378,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -394,14 +394,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -410,14 +410,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -428,14 +428,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -446,21 +446,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -470,14 +470,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -489,14 +489,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -505,14 +505,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -521,14 +521,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -536,7 +536,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -546,14 +546,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -566,14 +566,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -631,79 +631,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -724,14 +724,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -758,14 +758,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -803,14 +803,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -836,7 +836,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -846,14 +846,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -865,14 +865,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -881,14 +881,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -897,14 +897,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -915,14 +915,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -933,21 +933,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -957,14 +957,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -976,14 +976,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -992,14 +992,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1008,14 +1008,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1023,7 +1023,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1033,14 +1033,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1053,14 +1053,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -1070,12 +1070,13 @@

Method Details

- list(accountId, containerId, headers=None) + list(accountId, containerId, includeDeleted=None, headers=None)
Lists all Container Versions of a GTM Container.
 
 Args:
   accountId: string, The GTM Account ID. (required)
   containerId: string, The GTM Container ID. (required)
+  includeDeleted: boolean, Also retrieve deleted (archived) versions when true.
   headers: boolean, Retrieve headers only when true.
 
 Returns:
@@ -1121,79 +1122,79 @@ 

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -1214,14 +1215,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -1248,14 +1249,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -1293,14 +1294,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -1326,7 +1327,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1336,14 +1337,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1355,14 +1356,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1371,14 +1372,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1387,14 +1388,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -1405,14 +1406,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -1423,21 +1424,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1447,14 +1448,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1466,14 +1467,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1482,14 +1483,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1498,14 +1499,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1513,7 +1514,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1523,14 +1524,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1543,14 +1544,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -1599,79 +1600,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -1692,14 +1693,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -1726,14 +1727,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -1771,14 +1772,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -1804,7 +1805,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1814,14 +1815,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1833,14 +1834,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1849,14 +1850,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1865,14 +1866,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -1883,14 +1884,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -1901,21 +1902,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -1925,14 +1926,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -1944,14 +1945,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1960,14 +1961,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -1976,14 +1977,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -1991,7 +1992,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2001,14 +2002,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2021,14 +2022,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -2041,7 +2042,7 @@

Method Details

restore(accountId, containerId, containerVersionId) -
Restores a Container Version. This will overwrite the container's current configuration (including its macros, rules and tags). The operation will not have any effect on the version that is being served (i.e. the published version).
+  
Restores a Container Version. This will overwrite the container's current configuration (including its variables, triggers and tags). The operation will not have any effect on the version that is being served (i.e. the published version).
 
 Args:
   accountId: string, The GTM Account ID. (required)
@@ -2075,79 +2076,79 @@ 

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, - ], - "notes": "A String", # User notes on how to apply this container version in the container. - "rule": [ # The rules in the container that this version was taken from. - { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, + ], + "notes": "A String", # User notes on how to apply this container version in the container. + "rule": [ # The rules in the container that this version was taken from. + { # Represents a Google Tag Manager Rule. + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -2168,14 +2169,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -2202,14 +2203,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -2247,14 +2248,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -2280,7 +2281,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2290,14 +2291,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2309,14 +2310,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2325,14 +2326,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2341,14 +2342,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -2359,14 +2360,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -2377,21 +2378,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2401,14 +2402,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2420,14 +2421,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2436,14 +2437,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2452,14 +2453,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -2467,7 +2468,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2477,14 +2478,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2497,14 +2498,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -2549,79 +2550,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -2642,14 +2643,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -2676,14 +2677,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -2721,14 +2722,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -2754,7 +2755,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2764,14 +2765,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2783,14 +2784,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2799,14 +2800,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2815,14 +2816,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -2833,14 +2834,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -2851,21 +2852,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2875,14 +2876,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2894,14 +2895,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2910,14 +2911,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -2926,14 +2927,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -2941,7 +2942,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -2951,14 +2952,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -2971,14 +2972,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -3022,79 +3023,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -3115,14 +3116,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -3149,14 +3150,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -3194,14 +3195,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -3227,7 +3228,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3237,14 +3238,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3256,14 +3257,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3272,14 +3273,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3288,14 +3289,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -3306,14 +3307,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -3324,21 +3325,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3348,14 +3349,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3367,14 +3368,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3383,14 +3384,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3399,14 +3400,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -3414,7 +3415,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3424,14 +3425,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3444,14 +3445,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, @@ -3488,79 +3489,79 @@

Method Details

"deleted": True or False, # A value of true indicates this container version has been deleted. "macro": [ # The macros in the container that this version was taken from. { # Represents a Google Tag Manager Macro. - "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. - "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. - "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. - "containerId": "A String", # GTM Container ID. - "type": "A String", # GTM Macro Type. - "notes": "A String", # User notes on how to apply this macro in the container. - "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "name": "A String", # Macro display name. - "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. - "A String", - ], - "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. - "parameter": [ # The macro's parameters. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - "parentFolderId": "A String", # Parent folder id. - "accountId": "A String", # GTM Account ID. - }, + "scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro. + "scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro. + "macroId": "A String", # The Macro ID uniquely identifies the GTM Macro. + "containerId": "A String", # GTM Container ID. + "type": "A String", # GTM Macro Type. + "notes": "A String", # User notes on how to apply this macro in the container. + "enablingRuleId": [ # For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "name": "A String", # Macro display name. + "disablingRuleId": [ # For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. + "A String", + ], + "fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified. + "parameter": [ # The macro's parameters. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + "parentFolderId": "A String", # Parent folder id. + "accountId": "A String", # GTM Account ID. + }, ], "notes": "A String", # User notes on how to apply this container version in the container. "rule": [ # The rules in the container that this version was taken from. { # Represents a Google Tag Manager Rule. - "name": "A String", # Rule display name. - "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. - "notes": "A String", # User notes on how to apply this rule in the container. - "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. - "accountId": "A String", # GTM Account ID. - "condition": [ # The list of conditions that make up this rule (implicit AND between them). - { # Represents a predicate. - "type": "A String", # The type of operator for this condition. - "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. - # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. - { # Represents a Google Tag Manager Parameter. - "map": [ # This map parameter's parameters (must have keys; keys must be unique). - # Object with schema name: Parameter - ], - "list": [ # This list parameter's parameters (keys will be ignored). - # Object with schema name: Parameter - ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. - "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. - "type": "A String", # The parameter type. Valid values are: - # - boolean: The value represents a boolean, represented as 'true' or 'false' - # - integer: The value represents a 64-bit signed integer value, in base 10 - # - list: A list of parameters should be specified - # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) - }, - ], - }, - ], - "containerId": "A String", # GTM Container ID. - }, + "name": "A String", # Rule display name. + "ruleId": "A String", # The Rule ID uniquely identifies the GTM Rule. + "notes": "A String", # User notes on how to apply this rule in the container. + "fingerprint": "A String", # The fingerprint of the GTM Rule as computed at storage time. This value is recomputed whenever the rule is modified. + "accountId": "A String", # GTM Account ID. + "condition": [ # The list of conditions that make up this rule (implicit AND between them). + { # Represents a predicate. + "type": "A String", # The type of operator for this condition. + "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: + # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. + # - At this time, the left operand (arg0) must be a reference to a variable. + # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. + # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. + { # Represents a Google Tag Manager Parameter. + "map": [ # This map parameter's parameters (must have keys; keys must be unique). + # Object with schema name: Parameter + ], + "list": [ # This list parameter's parameters (keys will be ignored). + # Object with schema name: Parameter + ], + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. + "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. + "type": "A String", # The parameter type. Valid values are: + # - boolean: The value represents a boolean, represented as 'true' or 'false' + # - integer: The value represents a 64-bit signed integer value, in base 10 + # - list: A list of parameters should be specified + # - map: A map of parameters should be specified + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) + }, + ], + }, + ], + "containerId": "A String", # GTM Container ID. + }, ], "name": "A String", # Container version display name. "tag": [ # The tags in the container that this version was taken from. @@ -3581,14 +3582,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "setupTag": [ # The list of setup tags. Currently we only allow one. { @@ -3615,14 +3616,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @@ -3660,14 +3661,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], "parentFolderId": "A String", # Parent folder id. @@ -3693,7 +3694,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3703,14 +3704,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3722,14 +3723,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3738,14 +3739,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3754,14 +3755,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "containerId": "A String", # GTM Container ID. "type": "A String", # Defines the data layer event that causes this trigger. @@ -3772,14 +3773,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "parentFolderId": "A String", # Parent folder id. "name": "A String", # Trigger display name. @@ -3790,21 +3791,21 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "autoEventFilter": [ # Used in the case of auto event tracking. { # Represents a predicate. "type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3814,14 +3815,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3833,14 +3834,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3849,14 +3850,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers. "map": [ # This map parameter's parameters (must have keys; keys must be unique). @@ -3865,14 +3866,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified. "customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true. @@ -3880,7 +3881,7 @@

Method Details

"type": "A String", # The type of operator for this condition. "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: # - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - # - At this time, the left operand (arg0) must be a reference to a macro. + # - At this time, the left operand (arg0) must be a reference to a variable. # - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. # - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. { # Represents a Google Tag Manager Parameter. @@ -3890,14 +3891,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, ], }, @@ -3910,14 +3911,14 @@

Method Details

"list": [ # This list parameter's parameters (keys will be ignored). # Object with schema name: Parameter ], - "value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type. + "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. "type": "A String", # The parameter type. Valid values are: # - boolean: The value represents a boolean, represented as 'true' or 'false' # - integer: The value represents a 64-bit signed integer value, in base 10 # - list: A list of parameters should be specified # - map: A map of parameters should be specified - # - template: The value represents any text; this can include macro references (even macro references that might return non-string types) + # - template: The value represents any text; this can include variable references (even variable references that might return non-string types) }, "accountId": "A String", # GTM Account ID. }, diff --git a/docs/dyn/tasks_v1.tasklists.html b/docs/dyn/tasks_v1.tasklists.html index 626711773a0..3e70ee3cb37 100644 --- a/docs/dyn/tasks_v1.tasklists.html +++ b/docs/dyn/tasks_v1.tasklists.html @@ -117,10 +117,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }
@@ -134,10 +135,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. } @@ -146,10 +148,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }
@@ -159,7 +162,7 @@

Method Details

Args: pageToken: string, Token specifying the result page to return. Optional. - maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100. + maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100. Returns: An object of the form: @@ -169,10 +172,11 @@

Method Details

"items": [ # Collection of task lists. { "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }, ], "kind": "tasks#taskLists", # Type of the resource. This is always "tasks#taskLists". @@ -205,10 +209,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. } @@ -217,10 +222,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }
@@ -235,10 +241,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. } @@ -247,10 +254,11 @@

Method Details

{ "kind": "tasks#taskList", # Type of the resource. This is always "tasks#taskList". + "title": "A String", # Title of the task list. + "updated": "A String", # Last modification time of the task list (as a RFC 3339 timestamp). "etag": "A String", # ETag of the resource. "id": "A String", # Task list identifier. "selfLink": "A String", # URL pointing to this task list. Used to retrieve, update, or delete this task list. - "title": "A String", # Title of the task list. }
diff --git a/docs/dyn/tasks_v1.tasks.html b/docs/dyn/tasks_v1.tasks.html index 6f2117eeef1..d5808334f69 100644 --- a/docs/dyn/tasks_v1.tasks.html +++ b/docs/dyn/tasks_v1.tasks.html @@ -87,7 +87,7 @@

Instance Methods

insert(tasklist, body, parent=None, previous=None)

Creates a new task on the specified task list.

- list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None)

+ list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)

Returns all tasks in the specified task list.

list_next(previous_request, previous_response)

@@ -137,6 +137,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -164,6 +171,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -187,6 +201,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -201,21 +222,21 @@

Method Details

- list(tasklist, dueMax=None, pageToken=None, updatedMin=None, maxResults=None, completedMin=None, showDeleted=None, completedMax=None, showHidden=None, showCompleted=None, dueMin=None) + list(tasklist, showCompleted=None, dueMin=None, dueMax=None, pageToken=None, updatedMin=None, showDeleted=None, completedMax=None, maxResults=None, completedMin=None, showHidden=None)
Returns all tasks in the specified task list.
 
 Args:
   tasklist: string, Task list identifier. (required)
+  showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
+  dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
   dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
   pageToken: string, Token specifying the result page to return. Optional.
   updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by last modification time.
-  maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is 100.
-  completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
   showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional. The default is False.
   completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
+  maxResults: string, Maximum number of task lists returned on one page. Optional. The default is 100.
+  completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by completion date.
   showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional. The default is False.
-  showCompleted: boolean, Flag indicating whether completed tasks are returned in the result. Optional. The default is True.
-  dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by due date.
 
 Returns:
   An object of the form:
@@ -228,6 +249,13 @@ 

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -277,6 +305,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -305,6 +340,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -326,6 +368,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -354,6 +403,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. @@ -375,6 +431,13 @@

Method Details

"kind": "tasks#task", # Type of the resource. This is always "tasks#task". "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp). "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task. This field is read-only. Use the "move" method to move the task under a different parent or to the top level. + "links": [ # Collection of links. This collection is read-only. + { + "type": "A String", # Type of the link, e.g. "email". + "link": "A String", # The URL. + "description": "A String", # The description. In HTML speak: Everything between and . + }, + ], "title": "A String", # Title of the task. "deleted": True or False, # Flag indicating whether the task has been deleted. The default if False. "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed. diff --git a/docs/dyn/webmasters_v3.html b/docs/dyn/webmasters_v3.html index ab470263843..7545f89e002 100644 --- a/docs/dyn/webmasters_v3.html +++ b/docs/dyn/webmasters_v3.html @@ -72,7 +72,7 @@ -

Webmaster Tools API

+

Search Console API

Instance Methods

searchanalytics() diff --git a/docs/dyn/webmasters_v3.searchanalytics.html b/docs/dyn/webmasters_v3.searchanalytics.html index 8793df3ebfd..a6bede547d6 100644 --- a/docs/dyn/webmasters_v3.searchanalytics.html +++ b/docs/dyn/webmasters_v3.searchanalytics.html @@ -72,7 +72,7 @@ -

Webmaster Tools API . searchanalytics

+

Search Console API . searchanalytics

Instance Methods

query(siteUrl, body)

diff --git a/docs/dyn/webmasters_v3.sitemaps.html b/docs/dyn/webmasters_v3.sitemaps.html index 124a9b1e02a..a45abba02d8 100644 --- a/docs/dyn/webmasters_v3.sitemaps.html +++ b/docs/dyn/webmasters_v3.sitemaps.html @@ -72,7 +72,7 @@ -

Webmaster Tools API . sitemaps

+

Search Console API . sitemaps

Instance Methods

delete(siteUrl, feedpath)

diff --git a/docs/dyn/webmasters_v3.sites.html b/docs/dyn/webmasters_v3.sites.html index 36161c15e35..226ebb09c34 100644 --- a/docs/dyn/webmasters_v3.sites.html +++ b/docs/dyn/webmasters_v3.sites.html @@ -72,24 +72,24 @@ -

Webmaster Tools API . sites

+

Search Console API . sites

Instance Methods

add(siteUrl)

-

Adds a site to the set of the user's sites in Webmaster Tools.

+

Adds a site to the set of the user's sites in Search Console.

delete(siteUrl)

-

Removes a site from the set of the user's Webmaster Tools sites.

+

Removes a site from the set of the user's Search Console sites.

get(siteUrl)

Retrieves information about specific site.

list()

-

Lists the user's Webmaster Tools sites.

+

Lists the user's Search Console sites.

Method Details

add(siteUrl) -
Adds a site to the set of the user's sites in Webmaster Tools.
+  
Adds a site to the set of the user's sites in Search Console.
 
 Args:
   siteUrl: string, The URL of the site to add. (required)
@@ -98,7 +98,7 @@ 

Method Details

delete(siteUrl) -
Removes a site from the set of the user's Webmaster Tools sites.
+  
Removes a site from the set of the user's Search Console sites.
 
 Args:
   siteUrl: string, The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ (required)
@@ -115,7 +115,7 @@ 

Method Details

Returns: An object of the form: - { # Contains permission level information about a Webmaster Tools site. For more information, see Permissions in Webmaster Tools. + { # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console. "permissionLevel": "A String", # The user's permission level for the site. "siteUrl": "A String", # The URL of the site. }
@@ -123,7 +123,7 @@

Method Details

list() -
Lists the user's Webmaster Tools sites.
+  
Lists the user's Search Console sites.
 
 Args:
 
@@ -131,8 +131,8 @@ 

Method Details

An object of the form: { # List of sites with access level information. - "siteEntry": [ # Contains permission level information about a Webmaster Tools site. For more information, see Permissions in Webmaster Tools. - { # Contains permission level information about a Webmaster Tools site. For more information, see Permissions in Webmaster Tools. + "siteEntry": [ # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console. + { # Contains permission level information about a Search Console site. For more information, see Permissions in Search Console. "permissionLevel": "A String", # The user's permission level for the site. "siteUrl": "A String", # The URL of the site. }, diff --git a/docs/dyn/webmasters_v3.urlcrawlerrorscounts.html b/docs/dyn/webmasters_v3.urlcrawlerrorscounts.html index 4cbafc22aa2..a0c82754920 100644 --- a/docs/dyn/webmasters_v3.urlcrawlerrorscounts.html +++ b/docs/dyn/webmasters_v3.urlcrawlerrorscounts.html @@ -72,7 +72,7 @@ -

Webmaster Tools API . urlcrawlerrorscounts

+

Search Console API . urlcrawlerrorscounts

Instance Methods

query(siteUrl, category=None, platform=None, latestCountsOnly=None)

diff --git a/docs/dyn/webmasters_v3.urlcrawlerrorssamples.html b/docs/dyn/webmasters_v3.urlcrawlerrorssamples.html index e509e3815e1..cc302ae7575 100644 --- a/docs/dyn/webmasters_v3.urlcrawlerrorssamples.html +++ b/docs/dyn/webmasters_v3.urlcrawlerrorssamples.html @@ -72,7 +72,7 @@ -

Webmaster Tools API . urlcrawlerrorssamples

+

Search Console API . urlcrawlerrorssamples

Instance Methods

get(siteUrl, url, category, platform)

diff --git a/docs/dyn/youtubeAnalytics_v1.groups.html b/docs/dyn/youtubeAnalytics_v1.groups.html index a0b2ccf8a33..11f4e458da0 100644 --- a/docs/dyn/youtubeAnalytics_v1.groups.html +++ b/docs/dyn/youtubeAnalytics_v1.groups.html @@ -81,8 +81,11 @@

Instance Methods

insert(body, onBehalfOfContentOwner=None)

Creates a group.

- list(onBehalfOfContentOwner=None, mine=None, id=None)

+ list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)

Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

update(body, onBehalfOfContentOwner=None)

Modifies a group. For example, you could change a group's title.

@@ -144,13 +147,14 @@

Method Details

- list(onBehalfOfContentOwner=None, mine=None, id=None) + list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=None)
Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.
 
 Args:
   onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
 
 The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
+  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.
   mine: boolean, Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.
   id: string, The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.
 
@@ -158,6 +162,7 @@ 

Method Details

An object of the form: { # A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request. + "nextPageToken": "A String", "items": [ { "snippet": { @@ -178,6 +183,20 @@

Method Details

}
+
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+
update(body, onBehalfOfContentOwner=None)
Modifies a group. For example, you could change a group's title.
diff --git a/docs/dyn/youtube_v3.commentThreads.html b/docs/dyn/youtube_v3.commentThreads.html
index 4ef131a2eb3..bc90f1358fd 100644
--- a/docs/dyn/youtube_v3.commentThreads.html
+++ b/docs/dyn/youtube_v3.commentThreads.html
@@ -112,9 +112,7 @@ 

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -143,9 +141,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -183,9 +179,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -214,9 +208,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -297,9 +289,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -328,9 +318,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -397,9 +385,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -428,9 +414,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -468,9 +452,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -499,9 +481,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html index 91e00ad18fb..a4ba460fce3 100644 --- a/docs/dyn/youtube_v3.comments.html +++ b/docs/dyn/youtube_v3.comments.html @@ -123,9 +123,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -153,9 +151,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -210,9 +206,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -297,9 +291,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. @@ -327,9 +319,7 @@

Method Details

"videoId": "A String", # The ID of the video the comment refers to, if any. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "likeCount": 42, # The total number of likes this comment has received. - "authorChannelId": { # The id of the author's YouTube channel, if any. - "value": "A String", - }, + "authorChannelId": "", # The id of the author's YouTube channel, if any. "parentId": "A String", # The unique id of the parent comment, only set for replies. "publishedAt": "A String", # The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. "canRate": True or False, # Whether the current viewer can rate this comment. diff --git a/docs/dyn/youtube_v3.fanFundingEvents.html b/docs/dyn/youtube_v3.fanFundingEvents.html new file mode 100644 index 00000000000..1a5312821ef --- /dev/null +++ b/docs/dyn/youtube_v3.fanFundingEvents.html @@ -0,0 +1,149 @@ + + + +

YouTube Data API . fanFundingEvents

+

Instance Methods

+

+ list(part, pageToken=None, hl=None, maxResults=None)

+

Lists fan funding events for a channel.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ list(part, pageToken=None, hl=None, maxResults=None) +
Lists fan funding events for a channel.
+
+Args:
+  part: string, The part parameter specifies the fanFundingEvent resource parts that the API response will include. Supported values are id and snippet. (required)
+  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
+  hl: string, The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.
+
+If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
+  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
+
+Returns:
+  An object of the form:
+
+    {
+    "eventId": "A String", # Serialized EventId of the request which produced this response.
+    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+    "kind": "youtube#fanFundingEventListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#fanFundingEventListResponse".
+    "visitorId": "A String", # The visitorId identifies the visitor.
+    "items": [ # A list of fan funding events that match the request criteria.
+      { # A fanFundingEvent resource represents a fan funding event on a YouTube channel. Fan funding events occur when a user gives one-time monetary support to the channel owner.
+        "snippet": { # The snippet object contains basic details about the fan funding event.
+          "commentText": "A String", # The text contents of the comment left by the user.
+          "channelId": "A String", # Channel id where the funding event occurred.
+          "supporterDetails": { # Details about the supporter. Only filled if the event was made public by the user.
+            "channelId": "A String", # The YouTube channel ID.
+            "displayName": "A String", # The channel's display name.
+            "profileImageUrl": "A String", # The channels's avatar URL.
+            "channelUrl": "A String", # The channel's URL.
+          },
+          "amountMicros": "A String", # The amount of funding in micros of fund_currency. e.g., 1 is represented
+          "currency": "A String", # The currency in which the fund was made. ISO 4217.
+          "displayString": "A String", # A rendered string that displays the fund amount and currency (e.g., "$1.00"). The string is rendered for the given language.
+          "createdAt": "A String", # The date and time when the funding occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+        },
+        "kind": "youtube#fanFundingEvent", # Identifies what kind of resource this is. Value: the fixed string "youtube#fanFundingEvent".
+        "etag": "A String", # Etag of this resource.
+        "id": "A String", # The ID that YouTube assigns to uniquely identify the fan funding event.
+      },
+    ],
+    "tokenPagination": { # Stub token pagination template to suppress results.
+    },
+    "etag": "A String", # Etag of this resource.
+    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+      "totalResults": 42, # The total number of results in the result set.
+      "resultsPerPage": 42, # The number of results included in the API response.
+    },
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtube_v3.html b/docs/dyn/youtube_v3.html index 333375abf72..b2f03ee7448 100644 --- a/docs/dyn/youtube_v3.html +++ b/docs/dyn/youtube_v3.html @@ -109,6 +109,11 @@

Instance Methods

Returns the comments Resource.

+

+ fanFundingEvents() +

+

Returns the fanFundingEvents Resource.

+

guideCategories()

@@ -129,6 +134,21 @@

Instance Methods

Returns the liveBroadcasts Resource.

+

+ liveChatBans() +

+

Returns the liveChatBans Resource.

+ +

+ liveChatMessages() +

+

Returns the liveChatMessages Resource.

+ +

+ liveChatModerators() +

+

Returns the liveChatModerators Resource.

+

liveStreams()

@@ -149,6 +169,11 @@

Instance Methods

Returns the search Resource.

+

+ sponsors() +

+

Returns the sponsors Resource.

+

subscriptions()

diff --git a/docs/dyn/youtube_v3.liveBroadcasts.html b/docs/dyn/youtube_v3.liveBroadcasts.html index ffa626b70d9..fd6d1a32831 100644 --- a/docs/dyn/youtube_v3.liveBroadcasts.html +++ b/docs/dyn/youtube_v3.liveBroadcasts.html @@ -77,9 +77,6 @@

Instance Methods

bind(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)

Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.

-

- bind_direct(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None)

-

Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.

control(id, part, onBehalfOfContentOwner=None, displaySlate=None, onBehalfOfContentOwnerChannel=None, offsetTimeMs=None, walltime=None)

Controls the settings for a slate that can be displayed in the broadcast stream.

@@ -90,7 +87,7 @@

Instance Methods

insert(part=None, body, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None)

Creates a broadcast.

- list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None)

+ list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=None, id=None)

Returns a list of YouTube broadcasts that match the API request parameters.

list_next(previous_request, previous_response)

@@ -147,126 +144,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, - "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. - "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. - "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. - "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. - "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. - # - # - # - # Important: You must also set the enableDvr property's value to true if you want the playback to be available immediately after the broadcast ends. If you set this property's value to true but do not also set the enableDvr property to true, there may be a delay of around one day before the archived video will be available for playback. - "enableDvr": True or False, # This setting determines whether viewers can access DVR controls while watching the video. DVR controls enable the viewer to control the video playback experience by pausing, rewinding, or fast forwarding content. The default value for this property is true. - # - # - # - # Important: You must set the value to true and also set the enableArchive property's value to true if you want to make playback available immediately after the broadcast ends. - "monitorStream": { # Settings and Info of the monitor stream # The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly. - "broadcastStreamDelayMs": 42, # If you have set the enableMonitorStream property to true, then this property determines the length of the live broadcast delay. - "embedHtml": "A String", # HTML code that embeds a player that plays the monitor stream. - "enableMonitorStream": True or False, # This value determines whether the monitor stream is enabled for the broadcast. If the monitor stream is enabled, then YouTube will broadcast the event content on a special stream intended only for the broadcaster's consumption. The broadcaster can use the stream to review the event content and also to identify the optimal times to insert cuepoints. - # - # You need to set this value to true if you intend to have a broadcast delay for your event. - # - # Note: This property cannot be updated once the broadcast is in the testing or live state. - }, - }, - "snippet": { # The snippet object contains basic details about the event, including its title, description, start time, and end time. - "actualEndTime": "A String", # The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. - "description": "A String", # The broadcast's description. As with the title, you can set this field by modifying the broadcast resource or by setting the description field of the corresponding video resource. - "title": "A String", # The broadcast's title. Note that the broadcast represents exactly one YouTube video. You can set this field by modifying the broadcast resource or by setting the title field of the corresponding video resource. - "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast. - "publishedAt": "A String", # The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. - "liveChatId": "A String", # The id of the live chat for this broadcast. - "scheduledStartTime": "A String", # The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. - "actualStartTime": "A String", # The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. - "scheduledEndTime": "A String", # The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. - "isDefaultBroadcast": True or False, - "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the broadcast. For each nested object in this object, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. - "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. - "url": "A String", # The thumbnail image's URL. - "width": 42, # (Optional) Width of the thumbnail image. - "height": 42, # (Optional) Height of the thumbnail image. - }, - "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. - "url": "A String", # The thumbnail image's URL. - "width": 42, # (Optional) Width of the thumbnail image. - "height": 42, # (Optional) Height of the thumbnail image. - }, - "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. - "url": "A String", # The thumbnail image's URL. - "width": 42, # (Optional) Width of the thumbnail image. - "height": 42, # (Optional) Height of the thumbnail image. - }, - "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. - "url": "A String", # The thumbnail image's URL. - "width": 42, # (Optional) Width of the thumbnail image. - "height": 42, # (Optional) Height of the thumbnail image. - }, - "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. - "url": "A String", # The thumbnail image's URL. - "width": 42, # (Optional) Width of the thumbnail image. - "height": 42, # (Optional) Height of the thumbnail image. - }, - }, - }, - "etag": "A String", # Etag of this resource. - "id": "A String", # The ID that YouTube assigns to uniquely identify the broadcast. - }
-
- -
- bind_direct(id, part, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, streamId=None) -
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.
-
-Args:
-  id: string, The id parameter specifies the unique ID of the broadcast that is being bound to a video stream. (required)
-  part: string, The part parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (required)
-  onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
-
-The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
-  onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
-
-The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
-
-This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
-  streamId: string, The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
-
-Returns:
-  An object of the form:
-
-    { # A liveBroadcast resource represents an event that will be streamed, via live video, on YouTube.
-    "status": { # The status object contains information about the event's status.
-      "recordingStatus": "A String", # The broadcast's recording status.
-      "privacyStatus": "A String", # The broadcast's privacy status. Note that the broadcast represents exactly one YouTube video, so the privacy settings are identical to those supported for videos. In addition, you can set this field by modifying the broadcast resource or by setting the privacyStatus field of the corresponding video resource.
-      "lifeCycleStatus": "A String", # The broadcast's status. The status can be updated using the API's liveBroadcasts.transition method.
-      "liveBroadcastPriority": "A String", # Priority of the live broadcast event (internal state).
-    },
-    "topicDetails": {
-      "topics": [
-        {
-          "snippet": { # Information about the topic matched.
-            "releaseDate": "A String", # The date at which the topic was released. Filled for types: videoGame
-            "name": "A String", # The name of the topic.
-          },
-          "type": "A String", # The type of the topic.
-          "unmatched": True or False, # If this flag is set it means that we have not been able to match the topic title and type provided to a known entity.
-        },
-      ],
-    },
-    "kind": "youtube#liveBroadcast", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveBroadcast".
-    "statistics": { # Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts. # The statistics object contains info about the event's current stats. These include concurrent viewers and total chat count. Statistics can change (in either direction) during the lifetime of an event. Statistics are only returned while the event is live.
-      "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
-      "totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast.
-    },
-    "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded.
-      "enableLowLatency": True or False,
+      "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled.
       "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast.
       "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video.
-      "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API.
+      "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.
       "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.
+      "closedCaptionsType": "A String",
       "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast.
       "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true.
           #
@@ -383,11 +266,12 @@ 

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -506,11 +390,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -612,11 +497,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -683,7 +569,7 @@

Method Details

- list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, id=None) + list(part, broadcastStatus=None, onBehalfOfContentOwner=None, pageToken=None, onBehalfOfContentOwnerChannel=None, maxResults=None, mine=None, broadcastType=None, id=None)
Returns a list of YouTube broadcasts that match the API request parameters.
 
 Args:
@@ -705,6 +591,11 @@ 

Method Details

This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. mine: boolean, The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts. + broadcastType: string, The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now. + Allowed values + all - Return all broadcasts. + event - Return only scheduled event broadcasts. + persistent - Return only persistent broadcasts. id: string, The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID. Returns: @@ -741,11 +632,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -884,11 +776,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -992,11 +885,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # @@ -1098,11 +992,12 @@

Method Details

"totalChatCount": "A String", # The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast. }, "contentDetails": { # Detailed settings of a broadcast. # The contentDetails object contains information about the event's video content, such as whether the content can be shown in an embedded video player or if it will be archived and therefore available for viewing after the event has concluded. - "enableLowLatency": True or False, + "enableLowLatency": True or False, # Indicates whether this broadcast has low latency enabled. "boundStreamId": "A String", # This value uniquely identifies the live stream bound to the broadcast. "enableEmbed": True or False, # This setting indicates whether the broadcast video can be played in an embedded player. If you choose to archive the video (using the enableArchive property), this setting will also apply to the archived video. - "enableClosedCaptions": True or False, # This setting indicates whether closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. + "enableClosedCaptions": True or False, # This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. "startWithSlate": True or False, # This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers. + "closedCaptionsType": "A String", "enableContentEncryption": True or False, # This setting indicates whether YouTube should enable content encryption for the broadcast. "recordFromStart": True or False, # Automatically start recording after the event goes live. The default value for this property is true. # diff --git a/docs/dyn/youtube_v3.liveChatBans.html b/docs/dyn/youtube_v3.liveChatBans.html new file mode 100644 index 00000000000..ed3ecdd17ad --- /dev/null +++ b/docs/dyn/youtube_v3.liveChatBans.html @@ -0,0 +1,141 @@ + + + +

YouTube Data API . liveChatBans

+

Instance Methods

+

+ delete(id)

+

Removes a chat ban.

+

+ insert(part, body)

+

Adds a new ban to the chat.

+

Method Details

+
+ delete(id) +
Removes a chat ban.
+
+Args:
+  id: string, The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat. (required)
+
+
+ +
+ insert(part, body) +
Adds a new ban to the chat.
+
+Args:
+  part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A liveChatBan resource represents a ban for a YouTube live chat.
+    "snippet": { # The snippet object contains basic details about the ban.
+      "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
+      "liveChatId": "A String", # The chat this ban is pertinent to.
+      "bannedUserDetails": {
+        "channelId": "A String", # The YouTube channel ID.
+        "displayName": "A String", # The channel's display name.
+        "profileImageUrl": "A String", # The channels's avatar URL.
+        "channelUrl": "A String", # The channel's URL.
+      },
+      "type": "A String", # The type of ban.
+    },
+    "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
+    "etag": "A String", # Etag of this resource.
+    "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # A liveChatBan resource represents a ban for a YouTube live chat.
+      "snippet": { # The snippet object contains basic details about the ban.
+        "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
+        "liveChatId": "A String", # The chat this ban is pertinent to.
+        "bannedUserDetails": {
+          "channelId": "A String", # The YouTube channel ID.
+          "displayName": "A String", # The channel's display name.
+          "profileImageUrl": "A String", # The channels's avatar URL.
+          "channelUrl": "A String", # The channel's URL.
+        },
+        "type": "A String", # The type of ban.
+      },
+      "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
+      "etag": "A String", # Etag of this resource.
+      "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
+    }
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtube_v3.liveChatMessages.html b/docs/dyn/youtube_v3.liveChatMessages.html new file mode 100644 index 00000000000..b35fe987d0d --- /dev/null +++ b/docs/dyn/youtube_v3.liveChatMessages.html @@ -0,0 +1,261 @@ + + + +

YouTube Data API . liveChatMessages

+

Instance Methods

+

+ delete(id)

+

Deletes a chat message.

+

+ insert(part, body)

+

Adds a message to a live chat.

+

+ list(liveChatId, part, profileImageSize=None, hl=None, maxResults=None, pageToken=None)

+

Lists live chat messages for a specific chat.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ delete(id) +
Deletes a chat message.
+
+Args:
+  id: string, The id parameter specifies the YouTube chat message ID of the resource that is being deleted. (required)
+
+
+ +
+ insert(part, body) +
Adds a message to a live chat.
+
+Args:
+  part: string, The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
+    "snippet": { # The snippet object contains basic details about the message.
+      "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
+      "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+        "currency": "A String", # The currency in which the fund was made.
+        "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+        "userComment": "A String", # The comment added by the user to this fan funding event.
+        "amountMicros": "A String", # The amount of the fund.
+      },
+      "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+      "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+      "liveChatId": "A String",
+      "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor
+      "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+        "messageText": "A String", # The user's message.
+      },
+      "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
+    },
+    "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+    "etag": "A String", # Etag of this resource.
+    "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+      "displayName": "A String", # The channel's display name.
+      "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+      "channelId": "A String", # The YouTube channel ID.
+      "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+      "profileImageUrl": "A String", # The channels's avatar URL.
+      "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+      "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+      "channelUrl": "A String", # The channel's URL.
+    },
+    "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
+      "snippet": { # The snippet object contains basic details about the message.
+        "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
+        "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+          "currency": "A String", # The currency in which the fund was made.
+          "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+          "userComment": "A String", # The comment added by the user to this fan funding event.
+          "amountMicros": "A String", # The amount of the fund.
+        },
+        "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+        "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+        "liveChatId": "A String",
+        "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor
+        "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+          "messageText": "A String", # The user's message.
+        },
+        "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
+      },
+      "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+      "etag": "A String", # Etag of this resource.
+      "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+        "displayName": "A String", # The channel's display name.
+        "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+        "channelId": "A String", # The YouTube channel ID.
+        "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+        "profileImageUrl": "A String", # The channels's avatar URL.
+        "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+        "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+        "channelUrl": "A String", # The channel's URL.
+      },
+      "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+    }
+
+ +
+ list(liveChatId, part, profileImageSize=None, hl=None, maxResults=None, pageToken=None) +
Lists live chat messages for a specific chat.
+
+Args:
+  liveChatId: string, The liveChatId parameter specifies the ID of the chat whose messages will be returned. (required)
+  part: string, The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required)
+  profileImageSize: integer, The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88.
+  hl: string, The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.
+
+If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
+  maxResults: integer, The maxResults parameter specifies the maximum number of messages that should be returned in the result set.
+  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
+
+Returns:
+  An object of the form:
+
+    {
+    "eventId": "A String", # Serialized EventId of the request which produced this response.
+    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+    "kind": "youtube#liveChatMessageListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
+    "visitorId": "A String", # The visitorId identifies the visitor.
+    "items": [ # A list of live chat messages.
+      { # A liveChatMessage resource represents a chat message in a YouTube Live Chat.
+          "snippet": { # The snippet object contains basic details about the message.
+            "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent.
+            "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+              "currency": "A String", # The currency in which the fund was made.
+              "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user.
+              "userComment": "A String", # The comment added by the user to this fan funding event.
+              "amountMicros": "A String", # The amount of the fund.
+            },
+            "hasDisplayContent": True or False, # Whether the message has display content that should be displayed to users.
+            "publishedAt": "A String", # The date and time when the message was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+            "liveChatId": "A String",
+            "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor
+            "textMessageDetails": { # Details about the text message, this is only set if the type is 'textMessageEvent'.
+              "messageText": "A String", # The user's message.
+            },
+            "type": "A String", # The type of message, this will always be present, it determines the contents of the message as well as which fields will be present.
+          },
+          "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage".
+          "etag": "A String", # Etag of this resource.
+          "authorDetails": { # The authorDetails object contains basic details about the user that posted this message.
+            "displayName": "A String", # The channel's display name.
+            "isChatModerator": True or False, # Whether the author is a moderator of the live chat.
+            "channelId": "A String", # The YouTube channel ID.
+            "isChatSponsor": True or False, # Whether the author is a sponsor of the live chat.
+            "profileImageUrl": "A String", # The channels's avatar URL.
+            "isChatOwner": True or False, # Whether the author is the owner of the live chat.
+            "isVerified": True or False, # Whether the author's identity has been verified by YouTube.
+            "channelUrl": "A String", # The channel's URL.
+          },
+          "id": "A String", # The ID that YouTube assigns to uniquely identify the message.
+        },
+    ],
+    "tokenPagination": { # Stub token pagination template to suppress results.
+    },
+    "etag": "A String", # Etag of this resource.
+    "pollingIntervalMillis": 42, # The amount of time the client should wait before polling again.
+    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+      "totalResults": 42, # The total number of results in the result set.
+      "resultsPerPage": 42, # The number of results included in the API response.
+    },
+    "offlineAt": "A String", # The date and time when the underlying stream went offline. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtube_v3.liveChatModerators.html b/docs/dyn/youtube_v3.liveChatModerators.html new file mode 100644 index 00000000000..0586e40268f --- /dev/null +++ b/docs/dyn/youtube_v3.liveChatModerators.html @@ -0,0 +1,202 @@ + + + +

YouTube Data API . liveChatModerators

+

Instance Methods

+

+ delete(id)

+

Removes a chat moderator.

+

+ insert(part, body)

+

Adds a new moderator for the chat.

+

+ list(liveChatId, part, maxResults=None, pageToken=None)

+

Lists moderators for a live chat.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ delete(id) +
Removes a chat moderator.
+
+Args:
+  id: string, The id parameter identifies the chat moderator to remove. The value uniquely identifies both the moderator and the chat. (required)
+
+
+ +
+ insert(part, body) +
Adds a new moderator for the chat.
+
+Args:
+  part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet. (required)
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
+    "snippet": { # The snippet object contains basic details about the moderator.
+      "liveChatId": "A String", # The ID of the live chat this moderator can act on.
+      "moderatorDetails": { # Details about the moderator.
+        "channelId": "A String", # The YouTube channel ID.
+        "displayName": "A String", # The channel's display name.
+        "profileImageUrl": "A String", # The channels's avatar URL.
+        "channelUrl": "A String", # The channel's URL.
+      },
+    },
+    "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
+    "etag": "A String", # Etag of this resource.
+    "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
+  }
+
+
+Returns:
+  An object of the form:
+
+    { # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
+      "snippet": { # The snippet object contains basic details about the moderator.
+        "liveChatId": "A String", # The ID of the live chat this moderator can act on.
+        "moderatorDetails": { # Details about the moderator.
+          "channelId": "A String", # The YouTube channel ID.
+          "displayName": "A String", # The channel's display name.
+          "profileImageUrl": "A String", # The channels's avatar URL.
+          "channelUrl": "A String", # The channel's URL.
+        },
+      },
+      "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
+      "etag": "A String", # Etag of this resource.
+      "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
+    }
+
+ +
+ list(liveChatId, part, maxResults=None, pageToken=None) +
Lists moderators for a live chat.
+
+Args:
+  liveChatId: string, The liveChatId parameter specifies the YouTube live chat for which the API should return moderators. (required)
+  part: string, The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet. (required)
+  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
+  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
+
+Returns:
+  An object of the form:
+
+    {
+    "eventId": "A String", # Serialized EventId of the request which produced this response.
+    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+    "kind": "youtube#liveChatModeratorListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse".
+    "visitorId": "A String", # The visitorId identifies the visitor.
+    "items": [ # A list of moderators that match the request criteria.
+      { # A liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.
+          "snippet": { # The snippet object contains basic details about the moderator.
+            "liveChatId": "A String", # The ID of the live chat this moderator can act on.
+            "moderatorDetails": { # Details about the moderator.
+              "channelId": "A String", # The YouTube channel ID.
+              "displayName": "A String", # The channel's display name.
+              "profileImageUrl": "A String", # The channels's avatar URL.
+              "channelUrl": "A String", # The channel's URL.
+            },
+          },
+          "kind": "youtube#liveChatModerator", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator".
+          "etag": "A String", # Etag of this resource.
+          "id": "A String", # The ID that YouTube assigns to uniquely identify the moderator.
+        },
+    ],
+    "tokenPagination": { # Stub token pagination template to suppress results.
+    },
+    "etag": "A String", # Etag of this resource.
+    "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
+    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+      "totalResults": 42, # The total number of results in the result set.
+      "resultsPerPage": 42, # The number of results included in the API response.
+    },
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtube_v3.search.html b/docs/dyn/youtube_v3.search.html index 77b21339414..eb1b3611a54 100644 --- a/docs/dyn/youtube_v3.search.html +++ b/docs/dyn/youtube_v3.search.html @@ -238,6 +238,7 @@

Method Details

], "tokenPagination": { # Stub token pagination template to suppress results. }, + "regionCode": "A String", "etag": "A String", # Etag of this resource. "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. diff --git a/docs/dyn/youtube_v3.sponsors.html b/docs/dyn/youtube_v3.sponsors.html new file mode 100644 index 00000000000..22b4b471e33 --- /dev/null +++ b/docs/dyn/youtube_v3.sponsors.html @@ -0,0 +1,146 @@ + + + +

YouTube Data API . sponsors

+

Instance Methods

+

+ list(part, filter=None, pageToken=None, maxResults=None)

+

Lists sponsors for a channel.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ list(part, filter=None, pageToken=None, maxResults=None) +
Lists sponsors for a channel.
+
+Args:
+  part: string, The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. (required)
+  filter: string, The filter parameter specifies which channel sponsors to return.
+    Allowed values
+      all - Return all sponsors, from newest to oldest.
+      newest - Return the most recent sponsors, from newest to oldest.
+  pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
+  maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
+
+Returns:
+  An object of the form:
+
+    {
+    "eventId": "A String", # Serialized EventId of the request which produced this response.
+    "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
+    "kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse".
+    "visitorId": "A String", # The visitorId identifies the visitor.
+    "items": [ # A list of sponsors that match the request criteria.
+      { # A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits.
+        "snippet": { # The snippet object contains basic details about the sponsor.
+          "sponsorDetails": { # Details about the sponsor.
+            "channelId": "A String", # The YouTube channel ID.
+            "displayName": "A String", # The channel's display name.
+            "profileImageUrl": "A String", # The channels's avatar URL.
+            "channelUrl": "A String", # The channel's URL.
+          },
+          "channelId": "A String", # The id of the channel being sponsored.
+          "sponsorSince": "A String", # The date and time when the user became a sponsor. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
+        },
+        "kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor".
+        "etag": "A String", # Etag of this resource.
+        "id": "A String", # The ID that YouTube assigns to uniquely identify the sponsor.
+      },
+    ],
+    "tokenPagination": { # Stub token pagination template to suppress results.
+    },
+    "etag": "A String", # Etag of this resource.
+    "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
+      "totalResults": 42, # The total number of results in the result set.
+      "resultsPerPage": 42, # The number of results included in the API response.
+    },
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtube_v3.videos.html b/docs/dyn/youtube_v3.videos.html index 83d9050a619..2c4c1e2fe4a 100644 --- a/docs/dyn/youtube_v3.videos.html +++ b/docs/dyn/youtube_v3.videos.html @@ -151,11 +151,12 @@

Method Details

{ # A video resource represents a YouTube video. "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. - "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. - "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. - "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. + "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. + "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. + "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. }, "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. @@ -234,12 +235,13 @@

Method Details

], "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. }, - "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66 # Specifies the ratings that the video received under various rating schemes. + "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 67 # Specifies the ratings that the video received under various rating schemes. "cncRating": "A String", # Rating system in France - Commission de classification cinematographique "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). + "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). "chfilmRating": "A String", # The video's rating in Switzerland. @@ -276,9 +278,9 @@

Method Details

"acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. "grfilmRating": "A String", # The video's rating in Greece. "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. - "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. + "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism "czfilmRating": "A String", # The video's rating in the Czech Republic. - "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. + "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. @@ -316,7 +318,7 @@

Method Details

"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. }, - "ageGating": { # Age restriction details related to a video. + "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. "videoGameRating": "A String", # Video game rating, if any. @@ -427,21 +429,13 @@

Method Details

"A String", ], }, + "id": "A String", # The ID that YouTube uses to uniquely identify the video. "localizations": { # List with all localizations. "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types. "description": "A String", # Localized version of the video's description. "title": "A String", # Localized version of the video's title. }, }, - "id": "A String", # The ID that YouTube uses to uniquely identify the video. - "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts. - "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. - { - "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. - "context": "A String", # Defines the context of the ping. - }, - ], - }, } media_body: string, The filename of the media request body, or an instance of a MediaUpload object. @@ -462,11 +456,12 @@

Method Details

{ # A video resource represents a YouTube video. "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. - "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. - "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. - "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. + "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. + "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. + "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. }, "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. @@ -545,12 +540,13 @@

Method Details

], "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. }, - "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66 # Specifies the ratings that the video received under various rating schemes. + "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 67 # Specifies the ratings that the video received under various rating schemes. "cncRating": "A String", # Rating system in France - Commission de classification cinematographique "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). + "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). "chfilmRating": "A String", # The video's rating in Switzerland. @@ -587,9 +583,9 @@

Method Details

"acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. "grfilmRating": "A String", # The video's rating in Greece. "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. - "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. + "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism "czfilmRating": "A String", # The video's rating in the Czech Republic. - "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. + "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. @@ -627,7 +623,7 @@

Method Details

"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. }, - "ageGating": { # Age restriction details related to a video. + "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. "videoGameRating": "A String", # Video game rating, if any. @@ -738,21 +734,13 @@

Method Details

"A String", ], }, + "id": "A String", # The ID that YouTube uses to uniquely identify the video. "localizations": { # List with all localizations. "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types. "description": "A String", # Localized version of the video's description. "title": "A String", # Localized version of the video's title. }, }, - "id": "A String", # The ID that YouTube uses to uniquely identify the video. - "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts. - "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. - { - "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. - "context": "A String", # Defines the context of the ping. - }, - ], - }, }
@@ -799,11 +787,12 @@

Method Details

"items": [ # A list of videos that match the request criteria. { # A video resource represents a YouTube video. "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. - "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. - "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. - "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. + "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. + "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. + "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. }, "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. @@ -882,12 +871,13 @@

Method Details

], "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. }, - "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66 # Specifies the ratings that the video received under various rating schemes. + "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 67 # Specifies the ratings that the video received under various rating schemes. "cncRating": "A String", # Rating system in France - Commission de classification cinematographique "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). + "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). "chfilmRating": "A String", # The video's rating in Switzerland. @@ -924,9 +914,9 @@

Method Details

"acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. "grfilmRating": "A String", # The video's rating in Greece. "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. - "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. + "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism "czfilmRating": "A String", # The video's rating in the Czech Republic. - "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. + "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. @@ -964,7 +954,7 @@

Method Details

"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. }, - "ageGating": { # Age restriction details related to a video. + "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. "videoGameRating": "A String", # Video game rating, if any. @@ -1075,21 +1065,13 @@

Method Details

"A String", ], }, + "id": "A String", # The ID that YouTube uses to uniquely identify the video. "localizations": { # List with all localizations. "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types. "description": "A String", # Localized version of the video's description. "title": "A String", # Localized version of the video's title. }, }, - "id": "A String", # The ID that YouTube uses to uniquely identify the video. - "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts. - "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. - { - "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. - "context": "A String", # Defines the context of the ping. - }, - ], - }, }, ], "tokenPagination": { # Stub token pagination template to suppress results. @@ -1168,11 +1150,12 @@

Method Details

{ # A video resource represents a YouTube video. "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. - "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. - "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. - "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. + "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. + "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. + "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. }, "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. @@ -1251,12 +1234,13 @@

Method Details

], "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. }, - "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66 # Specifies the ratings that the video received under various rating schemes. + "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 67 # Specifies the ratings that the video received under various rating schemes. "cncRating": "A String", # Rating system in France - Commission de classification cinematographique "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). + "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). "chfilmRating": "A String", # The video's rating in Switzerland. @@ -1293,9 +1277,9 @@

Method Details

"acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. "grfilmRating": "A String", # The video's rating in Greece. "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. - "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. + "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism "czfilmRating": "A String", # The video's rating in the Czech Republic. - "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. + "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. @@ -1333,7 +1317,7 @@

Method Details

"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. }, - "ageGating": { # Age restriction details related to a video. + "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. "videoGameRating": "A String", # Video game rating, if any. @@ -1444,21 +1428,13 @@

Method Details

"A String", ], }, + "id": "A String", # The ID that YouTube uses to uniquely identify the video. "localizations": { # List with all localizations. "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types. "description": "A String", # Localized version of the video's description. "title": "A String", # Localized version of the video's title. }, }, - "id": "A String", # The ID that YouTube uses to uniquely identify the video. - "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts. - "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. - { - "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. - "context": "A String", # Defines the context of the ping. - }, - ], - }, } onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners. @@ -1470,11 +1446,12 @@

Method Details

{ # A video resource represents a YouTube video. "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. - "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. - "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. - "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over. + "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. + "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. + "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins. + "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. }, "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. @@ -1553,12 +1530,13 @@

Method Details

], "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. }, - "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 66 # Specifies the ratings that the video received under various rating schemes. + "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 67 # Specifies the ratings that the video received under various rating schemes. "cncRating": "A String", # Rating system in France - Commission de classification cinematographique "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). + "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). "chfilmRating": "A String", # The video's rating in Switzerland. @@ -1595,9 +1573,9 @@

Method Details

"acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. "grfilmRating": "A String", # The video's rating in Greece. "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. - "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. + "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism "czfilmRating": "A String", # The video's rating in the Czech Republic. - "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. + "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. @@ -1635,7 +1613,7 @@

Method Details

"licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. }, - "ageGating": { # Age restriction details related to a video. + "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. "videoGameRating": "A String", # Video game rating, if any. @@ -1746,21 +1724,13 @@

Method Details

"A String", ], }, + "id": "A String", # The ID that YouTube uses to uniquely identify the video. "localizations": { # List with all localizations. "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types. "description": "A String", # Localized version of the video's description. "title": "A String", # Localized version of the video's title. }, }, - "id": "A String", # The ID that YouTube uses to uniquely identify the video. - "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts. - "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping. - { - "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping. - "context": "A String", # Defines the context of the ping. - }, - ], - }, }
diff --git a/docs/dyn/youtubereporting_v1.html b/docs/dyn/youtubereporting_v1.html new file mode 100644 index 00000000000..c7e11d1950a --- /dev/null +++ b/docs/dyn/youtubereporting_v1.html @@ -0,0 +1,113 @@ + + + +

YouTube Reporting API

+

Instance Methods

+

+ jobs() +

+

Returns the jobs Resource.

+ +

+ media() +

+

Returns the media Resource.

+ +

+ reportTypes() +

+

Returns the reportTypes Resource.

+ +

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+        Args:
+          callback: callable, A callback to be called for each response, of the
+            form callback(id, response, exception). The first parameter is the
+            request id, and the second is the deserialized response object. The
+            third is an apiclient.errors.HttpError exception object if an HTTP
+            error occurred while processing the request, or None if no error
+            occurred.
+
+        Returns:
+          A BatchHttpRequest object based on the discovery document.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtubereporting_v1.jobs.html b/docs/dyn/youtubereporting_v1.jobs.html new file mode 100644 index 00000000000..a60d526ecac --- /dev/null +++ b/docs/dyn/youtubereporting_v1.jobs.html @@ -0,0 +1,203 @@ + + + +

YouTube Reporting API . jobs

+

Instance Methods

+

+ reports() +

+

Returns the reports Resource.

+ +

+ create(body, onBehalfOfContentOwner=None, x__xgafv=None)

+

Creates a job and returns it.

+

+ delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)

+

Deletes a job.

+

+ get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)

+

Gets a job.

+

+ list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists jobs.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ create(body, onBehalfOfContentOwner=None, x__xgafv=None) +
Creates a job and returns it.
+
+Args:
+  body: object, The request body. (required)
+    The object takes the form of:
+
+{ # A job creating reports of a specific type.
+    "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
+    "id": "A String", # The server-generated ID of the job (max. 40 characters).
+    "createTime": "A String", # The creation date/time of the job.
+    "name": "A String", # The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for
+  }
+
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A job creating reports of a specific type.
+      "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
+      "id": "A String", # The server-generated ID of the job (max. 40 characters).
+      "createTime": "A String", # The creation date/time of the job.
+      "name": "A String", # The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for
+    }
+
+ +
+ delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None) +
Deletes a job.
+
+Args:
+  jobId: string, The ID of the job to delete. (required)
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # 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 `{}`.
+  }
+
+ +
+ get(jobId, onBehalfOfContentOwner=None, x__xgafv=None) +
Gets a job.
+
+Args:
+  jobId: string, The ID of the job to retrieve. (required)
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A job creating reports of a specific type.
+      "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
+      "id": "A String", # The server-generated ID of the job (max. 40 characters).
+      "createTime": "A String", # The creation date/time of the job.
+      "name": "A String", # The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for
+    }
+
+ +
+ list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists jobs.
+
+Args:
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  pageSize: integer, Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Response message for ReportingService.ListJobs.
+    "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.
+    "jobs": [ # The list of jobs.
+      { # A job creating reports of a specific type.
+          "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a ReportType.
+          "id": "A String", # The server-generated ID of the job (max. 40 characters).
+          "createTime": "A String", # The creation date/time of the job.
+          "name": "A String", # The name of the job (max. 100 characters). TODO(lanthaler) Clarify what this will actually be used for
+        },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtubereporting_v1.jobs.reports.html b/docs/dyn/youtubereporting_v1.jobs.reports.html new file mode 100644 index 00000000000..f493a800395 --- /dev/null +++ b/docs/dyn/youtubereporting_v1.jobs.reports.html @@ -0,0 +1,154 @@ + + + +

YouTube Reporting API . jobs . reports

+

Instance Methods

+

+ get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None)

+

Gets the metadata of a specific report.

+

+ list(jobId, onBehalfOfContentOwner=None, pageSize=None, x__xgafv=None, createdAfter=None, pageToken=None)

+

Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ get(jobId, reportId, onBehalfOfContentOwner=None, x__xgafv=None) +
Gets the metadata of a specific report.
+
+Args:
+  jobId: string, The ID of the job. (required)
+  reportId: string, The ID of the report to retrieve. (required)
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # A report's metadata including the URL from which the report itself can be downloaded.
+    "jobId": "A String", # The ID of the job that created this report.
+    "id": "A String", # The server-generated ID of the report.
+    "downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
+    "startTime": "A String", # The start of the time period that the report instance covers. The value is inclusive.
+    "endTime": "A String", # The end of the time period that the report instance covers. The value is exclusive.
+    "createTime": "A String", # The date/time when this report was created.
+  }
+
+ +
+ list(jobId, onBehalfOfContentOwner=None, pageSize=None, x__xgafv=None, createdAfter=None, pageToken=None) +
Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.
+
+Args:
+  jobId: string, The ID of the job. (required)
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  pageSize: integer, Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
+  x__xgafv: string, V1 error format.
+  createdAfter: string, If set, only reports created after the specified date/time are returned.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method.
+
+Returns:
+  An object of the form:
+
+    { # Response message for ReportingService.ListReports.
+    "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results.
+    "reports": [ # The list of report types.
+      { # A report's metadata including the URL from which the report itself can be downloaded.
+        "jobId": "A String", # The ID of the job that created this report.
+        "id": "A String", # The server-generated ID of the report.
+        "downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
+        "startTime": "A String", # The start of the time period that the report instance covers. The value is inclusive.
+        "endTime": "A String", # The end of the time period that the report instance covers. The value is exclusive.
+        "createTime": "A String", # The date/time when this report was created.
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtubereporting_v1.media.html b/docs/dyn/youtubereporting_v1.media.html new file mode 100644 index 00000000000..834b17bc986 --- /dev/null +++ b/docs/dyn/youtubereporting_v1.media.html @@ -0,0 +1,114 @@ + + + +

YouTube Reporting API . media

+

Instance Methods

+

+ download(resourceName, x__xgafv=None)

+

Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.

+

+ download_media(resourceName, x__xgafv=None)

+

Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.

+

Method Details

+
+ download(resourceName, x__xgafv=None) +
Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Media resource.
+    "resourceName": "A String", # Name of the media resource.
+  }
+
+ +
+ download_media(resourceName, x__xgafv=None) +
Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.
+
+Args:
+  resourceName: string, Name of the media that is being downloaded. See [][ByteStream.ReadRequest.resource_name]. (required)
+  x__xgafv: string, V1 error format.
+
+Returns:
+  The media object as a string.
+
+    
+
+ + \ No newline at end of file diff --git a/docs/dyn/youtubereporting_v1.reportTypes.html b/docs/dyn/youtubereporting_v1.reportTypes.html new file mode 100644 index 00000000000..e7492d26a2f --- /dev/null +++ b/docs/dyn/youtubereporting_v1.reportTypes.html @@ -0,0 +1,122 @@ + + + +

YouTube Reporting API . reportTypes

+

Instance Methods

+

+ list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists report types.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists report types.
+
+Args:
+  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
+  pageSize: integer, Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+
+Returns:
+  An object of the form:
+
+    { # Response message for ReportingService.ListReportTypes.
+    "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results.
+    "reportTypes": [ # The list of report types.
+      { # A report type.
+        "id": "A String", # The ID of the report type (max. 100 characters).
+        "name": "A String", # The name of the report type (max. 100 characters).
+      },
+    ],
+  }
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+    
+
+ + \ No newline at end of file diff --git a/docs/epy/api-objects.txt b/docs/epy/api-objects.txt index 245f609378e..3c78fa477cb 100644 --- a/docs/epy/api-objects.txt +++ b/docs/epy/api-objects.txt @@ -55,6 +55,7 @@ googleapiclient.errors googleapiclient.errors-module.html googleapiclient.http googleapiclient.http-module.html googleapiclient.http.set_user_agent googleapiclient.http-module.html#set_user_agent googleapiclient.http.tunnel_patch googleapiclient.http-module.html#tunnel_patch +googleapiclient.http._retry_request googleapiclient.http-module.html#_retry_request googleapiclient.http.DEFAULT_CHUNK_SIZE googleapiclient.http-module.html#DEFAULT_CHUNK_SIZE googleapiclient.http.MAX_URI_LENGTH googleapiclient.http-module.html#MAX_URI_LENGTH googleapiclient.mimeparse googleapiclient.mimeparse-module.html @@ -92,6 +93,8 @@ googleapiclient.discovery.Resource._add_basic_methods googleapiclient.discovery. googleapiclient.discovery.ResourceMethodParameters googleapiclient.discovery.ResourceMethodParameters-class.html googleapiclient.discovery.ResourceMethodParameters.set_parameters googleapiclient.discovery.ResourceMethodParameters-class.html#set_parameters googleapiclient.discovery.ResourceMethodParameters.__init__ googleapiclient.discovery.ResourceMethodParameters-class.html#__init__ +googleapiclient.discovery._BytesGenerator googleapiclient.discovery._BytesGenerator-class.html +googleapiclient.discovery._BytesGenerator._write_lines googleapiclient.discovery._BytesGenerator-class.html#_write_lines googleapiclient.discovery_cache.appengine_memcache.Cache googleapiclient.discovery_cache.appengine_memcache.Cache-class.html googleapiclient.discovery_cache.appengine_memcache.Cache.set googleapiclient.discovery_cache.appengine_memcache.Cache-class.html#set googleapiclient.discovery_cache.base.Cache.__metaclass__ googleapiclient.discovery_cache.base.Cache-class.html#__metaclass__ diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html index 208e33e1b04..5c5bca966be 100644 --- a/docs/epy/class-tree.html +++ b/docs/epy/class-tree.html @@ -55,6 +55,8 @@

Class Hierarchy