From cb945f37130d2950801e02512761f061cef0b54e Mon Sep 17 00:00:00 2001
From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com>
Date: Tue, 8 Jun 2021 00:36:03 -0700
Subject: [PATCH] chore: Update discovery artifacts (#1405)
## Deleted keys were detected in the following stable discovery artifacts:
apigee v1 https://github.com/googleapis/google-api-python-client/commit/e1ea8735612457f6f8b85226887babd904958b25
## Discovery Artifact Change Summary:
feat(apigee): update the api https://github.com/googleapis/google-api-python-client/commit/e1ea8735612457f6f8b85226887babd904958b25
feat(content): update the api https://github.com/googleapis/google-api-python-client/commit/097e3329e1e5de3ae416cdabc9a73e2fa63a09e9
feat(documentai): update the api https://github.com/googleapis/google-api-python-client/commit/72f3faea1be17c074dc566b33707dad37c9ba16b
feat(servicemanagement): update the api https://github.com/googleapis/google-api-python-client/commit/491bafaefd792deae68c24337ebd7011faeb723b
---
...dpublisher_v3.purchases.subscriptions.html | 2 +-
...gee_v1.organizations.apis.deployments.html | 1 -
...anizations.apis.revisions.deployments.html | 1 -
.../apigee_v1.organizations.deployments.html | 1 -
...zations.environments.apis.deployments.html | 1 -
...nizations.environments.apis.revisions.html | 7 +-
...rganizations.environments.deployments.html | 1 -
....environments.sharedflows.deployments.html | 1 -
...ns.environments.sharedflows.revisions.html | 7 +-
...organizations.sharedflows.deployments.html | 1 -
...ons.sharedflows.revisions.deployments.html | 1 -
...oudtasks_v2.projects.locations.queues.html | 18 +-
docs/dyn/content_v2_1.products.html | 32 +-
docs/dyn/content_v2_1.reports.html | 40 ++
docs/dyn/datastore_v1.projects.html | 286 +++------
...ocations.processors.humanReviewConfig.html | 3 +-
...ocations.processors.humanReviewConfig.html | 3 +-
docs/dyn/index.md | 4 +
docs/dyn/keep_v1.html | 116 ++++
docs/dyn/keep_v1.media.html | 133 ++++
docs/dyn/keep_v1.notes.html | 396 ++++++++++++
docs/dyn/keep_v1.notes.permissions.html | 178 ++++++
...a.projects.locations.services.backups.html | 172 -----
...a.projects.locations.services.backups.html | 172 -----
...projects.instances.databases.sessions.html | 66 +-
.../documents/abusiveexperiencereport.v1.json | 2 +-
.../acceleratedmobilepageurl.v1.json | 2 +-
.../documents/adexchangebuyer.v1.2.json | 4 +-
.../documents/adexchangebuyer.v1.3.json | 4 +-
.../documents/adexchangebuyer.v1.4.json | 4 +-
.../documents/adexperiencereport.v1.json | 2 +-
.../discovery_cache/documents/admob.v1.json | 2 +-
.../documents/admob.v1beta.json | 2 +-
.../discovery_cache/documents/adsense.v2.json | 2 +-
.../documents/analyticsdata.v1beta.json | 2 +-
.../androiddeviceprovisioning.v1.json | 2 +-
.../documents/androidmanagement.v1.json | 2 +-
.../documents/androidpublisher.v3.json | 4 +-
.../documents/apigateway.v1beta.json | 2 +-
.../discovery_cache/documents/apigee.v1.json | 16 +-
.../discovery_cache/documents/apikeys.v2.json | 2 +-
.../documents/area120tables.v1alpha1.json | 2 +-
.../documents/assuredworkloads.v1.json | 2 +-
.../documents/calendar.v3.json | 2 +-
.../documents/chromemanagement.v1.json | 2 +-
.../documents/chromepolicy.v1.json | 2 +-
.../documents/cloudchannel.v1.json | 2 +-
.../documents/cloudscheduler.v1.json | 2 +-
.../documents/cloudscheduler.v1beta1.json | 2 +-
.../documents/cloudtasks.v2.json | 4 +-
.../documents/cloudtasks.v2beta2.json | 2 +-
.../documents/content.v2.1.json | 167 ++++-
.../discovery_cache/documents/content.v2.json | 2 +-
.../documents/customsearch.v1.json | 2 +-
.../documents/dialogflow.v2.json | 2 +-
.../documents/dialogflow.v2beta1.json | 2 +-
.../documents/dialogflow.v3.json | 2 +-
.../documents/dialogflow.v3beta1.json | 2 +-
.../discovery_cache/documents/dns.v1.json | 2 +-
.../documents/dns.v1beta2.json | 2 +-
.../discovery_cache/documents/docs.v1.json | 2 +-
.../documents/documentai.v1.json | 53 +-
.../documents/documentai.v1beta2.json | 47 +-
.../documents/documentai.v1beta3.json | 53 +-
.../documents/domains.v1beta1.json | 2 +-
.../documents/firebase.v1beta1.json | 2 +-
.../documents/firebasedatabase.v1beta.json | 2 +-
.../discovery_cache/documents/fitness.v1.json | 2 +-
.../documents/gameservices.v1beta.json | 2 +-
.../documents/gmailpostmastertools.v1.json | 2 +-
.../gmailpostmastertools.v1beta1.json | 2 +-
.../discovery_cache/documents/keep.v1.json | 587 ++++++++++++++++++
.../documents/language.v1.json | 2 +-
.../documents/language.v1beta1.json | 2 +-
.../documents/language.v1beta2.json | 2 +-
.../documents/libraryagent.v1.json | 2 +-
.../documents/licensing.v1.json | 2 +-
.../documents/localservices.v1.json | 2 +-
.../documents/manufacturers.v1.json | 2 +-
.../discovery_cache/documents/ml.v1.json | 2 +-
.../documents/networkmanagement.v1beta1.json | 2 +-
.../documents/orgpolicy.v2.json | 2 +-
.../documents/pagespeedonline.v5.json | 2 +-
.../paymentsresellersubscription.v1.json | 2 +-
.../documents/playcustomapp.v1.json | 2 +-
.../documents/prod_tt_sasportal.v1alpha1.json | 2 +-
.../documents/runtimeconfig.v1.json | 2 +-
.../documents/safebrowsing.v4.json | 38 +-
.../serviceconsumermanagement.v1.json | 2 +-
.../serviceconsumermanagement.v1beta1.json | 2 +-
.../documents/servicedirectory.v1.json | 2 +-
.../documents/servicedirectory.v1beta1.json | 2 +-
.../documents/servicemanagement.v1.json | 17 +-
.../documents/servicenetworking.v1.json | 2 +-
.../documents/servicenetworking.v1beta.json | 2 +-
.../documents/serviceusage.v1.json | 2 +-
.../documents/serviceusage.v1beta1.json | 2 +-
.../discovery_cache/documents/slides.v1.json | 2 +-
.../documents/smartdevicemanagement.v1.json | 2 +-
.../discovery_cache/documents/storage.v1.json | 4 +-
.../documents/streetviewpublish.v1.json | 2 +-
.../discovery_cache/documents/tasks.v1.json | 2 +-
.../documents/texttospeech.v1.json | 2 +-
.../documents/texttospeech.v1beta1.json | 2 +-
.../documents/toolresults.v1beta3.json | 2 +-
.../documents/youtubeAnalytics.v2.json | 2 +-
.../documents/youtubereporting.v1.json | 2 +-
107 files changed, 2029 insertions(+), 752 deletions(-)
create mode 100644 docs/dyn/keep_v1.html
create mode 100644 docs/dyn/keep_v1.media.html
create mode 100644 docs/dyn/keep_v1.notes.html
create mode 100644 docs/dyn/keep_v1.notes.permissions.html
create mode 100644 googleapiclient/discovery_cache/documents/keep.v1.json
diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html
index 3128ea33a22..fe344688853 100644
--- a/docs/dyn/androidpublisher_v3.purchases.subscriptions.html
+++ b/docs/dyn/androidpublisher_v3.purchases.subscriptions.html
@@ -211,7 +211,7 @@
Method Details
"linkedPurchaseToken": "A String", # The purchase token of the originating purchase if this subscription is one of the following: 0. Re-signup of a canceled but non-lapsed subscription 1. Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set.
"obfuscatedExternalAccountId": "A String", # An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.
"obfuscatedExternalProfileId": "A String", # An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.
- "orderId": "A String", # The order id of the latest recurring order associated with the purchase of the subscription.
+ "orderId": "A String", # The order id of the latest recurring order associated with the purchase of the subscription. If the subscription was canceled because payment was declined, this will be the order id from the payment declined order.
"paymentState": 42, # The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.
"priceAmountMicros": "A String", # Price of the subscription, For tax exclusive countries, the price doesn't include tax. For tax inclusive countries, the price includes tax. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000.
"priceChange": { # Contains the price change information for a subscription that can be used to control the user journey for the price change in the app. This can be in the form of seeking confirmation from the user or tailoring the experience for a successful conversion. # The latest price change information available. This is present only when there is an upcoming price change for the subscription yet to be applied. Once the subscription renews with the new price or the subscription is canceled, no price change information will be returned.
diff --git a/docs/dyn/apigee_v1.organizations.apis.deployments.html b/docs/dyn/apigee_v1.organizations.apis.deployments.html
index 9620cdd62d1..88002456282 100644
--- a/docs/dyn/apigee_v1.organizations.apis.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.apis.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.apis.revisions.deployments.html b/docs/dyn/apigee_v1.organizations.apis.revisions.deployments.html
index 702cef0bf3c..1e285355213 100644
--- a/docs/dyn/apigee_v1.organizations.apis.revisions.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.apis.revisions.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.deployments.html b/docs/dyn/apigee_v1.organizations.deployments.html
index 4ce3a3d76f3..0ae570e926b 100644
--- a/docs/dyn/apigee_v1.organizations.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.deployments.html
@@ -163,7 +163,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html b/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
index d96f2a03967..72b8196751c 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
index 8484bad09b6..09a7e0b8a0c 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.html
@@ -88,7 +88,7 @@ Instance Methods
close()
Close httplib2 connections.
- deploy(name, override=None, sequencedRollout=None, serviceAccount=None, x__xgafv=None)
+ deploy(name, override=None, sequencedRollout=None, x__xgafv=None)
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`
getDeployments(name, x__xgafv=None)
@@ -103,14 +103,13 @@ Method Details
-
deploy(name, override=None, sequencedRollout=None, serviceAccount=None, x__xgafv=None)
+
deploy(name, override=None, sequencedRollout=None, x__xgafv=None)
Deploys a revision of an API proxy. If another revision of the same API proxy revision is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision. For a request path `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.proxyrevisions.deploy` on the resource `organizations/{org}/apis/{api}/revisions/{rev}`
Args:
name: string, Required. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` (required)
override: boolean, Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set `override` to `true` to replace other deployed revisions. By default, `override` is `false` and the deployment is rejected if other revisions of the API proxy are deployed in the environment.
sequencedRollout: boolean, Flag that specifies whether to enable sequenced rollout. If set to `true`, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.
- serviceAccount: string, Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -179,7 +178,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
}
@@ -258,7 +256,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
}
diff --git a/docs/dyn/apigee_v1.organizations.environments.deployments.html b/docs/dyn/apigee_v1.organizations.environments.deployments.html
index 110b0969a0a..0a6d7b92f17 100644
--- a/docs/dyn/apigee_v1.organizations.environments.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.deployments.html
@@ -163,7 +163,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.environments.sharedflows.deployments.html b/docs/dyn/apigee_v1.organizations.environments.sharedflows.deployments.html
index d22315312a3..74a70e93177 100644
--- a/docs/dyn/apigee_v1.organizations.environments.sharedflows.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.environments.sharedflows.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.environments.sharedflows.revisions.html b/docs/dyn/apigee_v1.organizations.environments.sharedflows.revisions.html
index 23ef5bd7b31..ffa5efa2656 100644
--- a/docs/dyn/apigee_v1.organizations.environments.sharedflows.revisions.html
+++ b/docs/dyn/apigee_v1.organizations.environments.sharedflows.revisions.html
@@ -78,7 +78,7 @@ Instance Methods
close()
Close httplib2 connections.
- deploy(name, override=None, serviceAccount=None, x__xgafv=None)
+ deploy(name, override=None, x__xgafv=None)
Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`
getDeployments(name, x__xgafv=None)
@@ -93,13 +93,12 @@ Method Details
-
deploy(name, override=None, serviceAccount=None, x__xgafv=None)
+
deploy(name, override=None, x__xgafv=None)
Deploys a revision of a shared flow. If another revision of the same shared flow is currently deployed, set the `override` parameter to `true` to have this revision replace the currently deployed revision. You cannot use a shared flow until it has been deployed to an environment. For a request path `organizations/{org}/environments/{env}/sharedflows/{sf}/revisions/{rev}/deployments`, two permissions are required: * `apigee.deployments.create` on the resource `organizations/{org}/environments/{env}` * `apigee.sharedflowrevisions.deploy` on the resource `organizations/{org}/sharedflows/{sf}/revisions/{rev}`
Args:
name: string, Required. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` (required)
override: boolean, Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow in the environment. Set `override` to `true` to replace other deployed revisions. By default, `override` is `false` and the deployment is rejected if other revisions of the shared flow are deployed in the environment.
- serviceAccount: string, Google Cloud IAM service account. The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be `{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -168,7 +167,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
}
@@ -247,7 +245,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
}
diff --git a/docs/dyn/apigee_v1.organizations.sharedflows.deployments.html b/docs/dyn/apigee_v1.organizations.sharedflows.deployments.html
index f7fd8406361..145fac017c4 100644
--- a/docs/dyn/apigee_v1.organizations.sharedflows.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.sharedflows.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/apigee_v1.organizations.sharedflows.revisions.deployments.html b/docs/dyn/apigee_v1.organizations.sharedflows.revisions.deployments.html
index ff63b5841e5..b97e818f45f 100644
--- a/docs/dyn/apigee_v1.organizations.sharedflows.revisions.deployments.html
+++ b/docs/dyn/apigee_v1.organizations.sharedflows.revisions.deployments.html
@@ -162,7 +162,6 @@ Method Details
"environmentGroup": "A String", # Name of the environment group in which this conflict exists.
},
],
- "serviceAccount": "A String", # The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`.
"state": "A String", # Current state of the deployment. This field is not populated in List APIs.
},
],
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index 016d5d7fe04..45d09d595f0 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -157,7 +157,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
x__xgafv: string, V1 error format.
@@ -192,7 +192,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
@@ -252,7 +252,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
@@ -343,7 +343,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
},
],
}
@@ -396,7 +396,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
updateMask: string, A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated.
@@ -432,7 +432,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
@@ -480,7 +480,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
@@ -528,7 +528,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
@@ -576,7 +576,7 @@ Method Details
"stackdriverLoggingConfig": { # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). # Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written.
"samplingRatio": 3.14, # Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.
},
- "state": "A String", # Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
+ "state": "A String", # Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
}
diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html
index b3175a7f890..6c5660ba3c4 100644
--- a/docs/dyn/content_v2_1.products.html
+++ b/docs/dyn/content_v2_1.products.html
@@ -190,7 +190,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -202,7 +202,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -411,7 +411,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -423,7 +423,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -638,7 +638,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -650,7 +650,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -840,7 +840,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -852,7 +852,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -1041,7 +1041,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -1053,7 +1053,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -1254,7 +1254,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -1266,7 +1266,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -1473,7 +1473,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -1485,7 +1485,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
@@ -1674,7 +1674,7 @@ Method Details
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"link": "A String", # URL directly linking to your item's page on your website.
- "linkTemplate": "A String", # Link template for merchant hosted local storefront.
+ "linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"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.
@@ -1686,7 +1686,7 @@ Method Details
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
- "mobileLinkTemplate": "A String", # Link template for merchant hosted local storefront optimized for mobile devices.
+ "mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
diff --git a/docs/dyn/content_v2_1.reports.html b/docs/dyn/content_v2_1.reports.html
index 5e0463171a9..769ad219533 100644
--- a/docs/dyn/content_v2_1.reports.html
+++ b/docs/dyn/content_v2_1.reports.html
@@ -117,18 +117,58 @@ Method Details
"results": [ # Rows that matched the search query.
{ # Result row returned from the search query.
"metrics": { # Performance metrics. Values are only set for metrics requested explicitly in the request's search query. # Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query.
+ "aos": 3.14, # Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions.**
+ "aovMicros": 3.14, # Average order value - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions.**
"clicks": "A String", # Number of clicks.
"ctr": 3.14, # Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).
+ "daysToShip": 3.14, # Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions.**
"impressions": "A String", # Number of times merchant's products are shown.
+ "itemDaysToShip": 3.14, # Average number of days between an item being ordered and the item being
+ "itemFillRate": 3.14, # Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections.
+ "orderedItemSalesMicros": "A String", # Total price of ordered items. Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
+ "orderedItems": "A String", # Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order.
+ "orders": "A String", # Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions.**
+ "rejectedItems": "A String", # Number of ordered items canceled by the merchant, reported on the order date.
+ "returnRate": 3.14, # Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
+ "returnedItems": "A String", # Number of ordered items sent back for return, reported on the date when the merchant accepted the return.
+ "returnsMicros": "A String", # Total price of ordered items sent back for return, reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
+ "shippedItemSalesMicros": "A String", # Total price of shipped items, reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.
+ "shippedItems": "A String", # Number of shipped items, reported on the shipment date.
+ "shippedOrders": "A String", # Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions.**
+ "unshippedItems": 3.14, # Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period.
+ "unshippedOrders": 3.14, # Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions.**
},
"segments": { # Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query. # Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query.
+ "brand": "A String", # Brand of the product.
+ "categoryL1": "A String", # Product category (1st level) in Google's product taxonomy.
+ "categoryL2": "A String", # Product category (2nd level) in Google's product taxonomy.
+ "categoryL3": "A String", # Product category (3rd level) in Google's product taxonomy.
+ "categoryL4": "A String", # Product category (4th level) in Google's product taxonomy.
+ "categoryL5": "A String", # Product category (5th level) in Google's product taxonomy.
+ "currencyCode": "A String", # Currency in which price metrics are represented, e.g., if you select `ordered_item_sales_micros`, the returned value will be represented by this currency.
+ "customLabel0": "A String", # Custom label 0 for custom grouping of products.
+ "customLabel1": "A String", # Custom label 1 for custom grouping of products.
+ "customLabel2": "A String", # Custom label 2 for custom grouping of products.
+ "customLabel3": "A String", # Custom label 3 for custom grouping of products.
+ "customLabel4": "A String", # Custom label 4 for custom grouping of products.
"date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Date in the merchant timezone to which metrics apply.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"offerId": "A String", # Merchant-provided id of the product.
+ "productTypeL1": "A String", # Product category (1st level) in merchant's own product taxonomy.
+ "productTypeL2": "A String", # Product category (2nd level) in merchant's own product taxonomy.
+ "productTypeL3": "A String", # Product category (3rd level) in merchant's own product taxonomy.
+ "productTypeL4": "A String", # Product category (4th level) in merchant's own product taxonomy.
+ "productTypeL5": "A String", # Product category (5th level) in merchant's own product taxonomy.
"program": "A String", # Program to which metrics apply, e.g., Free Product Listing.
+ "title": "A String", # Title of the product.
+ "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # First day of the week (Monday) of the metrics date in the merchant timezone.
+ "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+ "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ },
},
},
],
diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html
index 96acf9cb890..4f71a3fd441 100644
--- a/docs/dyn/datastore_v1.projects.html
+++ b/docs/dyn/datastore_v1.projects.html
@@ -248,40 +248,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path.
@@ -299,40 +266,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
@@ -350,40 +284,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
},
@@ -602,40 +503,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -659,40 +527,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -790,7 +625,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -829,7 +681,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -890,7 +759,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -977,40 +863,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -1049,7 +902,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
index a5a91cd5722..db1fab56da6 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
@@ -95,7 +95,8 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Request message for review document method.
+{ # Request message for review document method. Next Id: 5.
+ "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request.
"inlineDocument": { # Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality. # An inline document proto.
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
index e5fb4795838..a948bd53b04 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
@@ -95,7 +95,7 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # Request message for review document method.
+{ # Request message for review document method. Next Id: 5.
"document": { # Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality. # The document that needs human review.
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
@@ -789,6 +789,7 @@ Method Details
],
"uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.
},
+ "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request.
"inlineDocument": { # Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality. # An inline document proto.
"content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
"entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index 8716f09f551..a1ee160f221 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -571,6 +571,10 @@
* [v4](http://googleapis.github.io/google-api-python-client/docs/dyn/jobs_v4.html)
+## keep
+* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/keep_v1.html)
+
+
## kgsearch
* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/kgsearch_v1.html)
diff --git a/docs/dyn/keep_v1.html b/docs/dyn/keep_v1.html
new file mode 100644
index 00000000000..e6d86309645
--- /dev/null
+++ b/docs/dyn/keep_v1.html
@@ -0,0 +1,116 @@
+
+
+
+
+Instance Methods
+
+ media()
+
+Returns the media Resource.
+
+
+ notes()
+
+Returns the notes Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ new_batch_http_request()
+Create a BatchHttpRequest object based on the discovery document.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
+
+
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/keep_v1.media.html b/docs/dyn/keep_v1.media.html
new file mode 100644
index 00000000000..4165440ff33
--- /dev/null
+++ b/docs/dyn/keep_v1.media.html
@@ -0,0 +1,133 @@
+
+
+
+
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ download(name, mimeType=None, x__xgafv=None)
+Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
+
+ download_media(name, mimeType=None, x__xgafv=None)
+Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
+
+
download(name, mimeType=None, x__xgafv=None)
+
Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
+
+Args:
+ name: string, Required. The name of the attachment. (required)
+ mimeType: string, The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An attachment to a note.
+ "mimeType": [ # The MIME types (IANA media types) in which the attachment is available.
+ "A String",
+ ],
+ "name": "A String", # The resource name;
+}
+
+
+
+
download_media(name, mimeType=None, x__xgafv=None)
+
Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.
+
+Args:
+ name: string, Required. The name of the attachment. (required)
+ mimeType: string, The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ The media object as a string.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/keep_v1.notes.html b/docs/dyn/keep_v1.notes.html
new file mode 100644
index 00000000000..2e1b602ee0a
--- /dev/null
+++ b/docs/dyn/keep_v1.notes.html
@@ -0,0 +1,396 @@
+
+
+
+
+Instance Methods
+
+ permissions()
+
+Returns the permissions Resource.
+
+
+ close()
+Close httplib2 connections.
+
+ create(body=None, x__xgafv=None)
+Creates a new note.
+
+ delete(name, x__xgafv=None)
+Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
+
+ get(name, x__xgafv=None)
+Gets a note.
+
+ list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
+Method Details
+
+
close()
+
Close httplib2 connections.
+
+
+
+
create(body=None, x__xgafv=None)
+
Creates a new note.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A single note.
+ "attachments": [ # Output only. The attachments attached to this note.
+ { # An attachment to a note.
+ "mimeType": [ # The MIME types (IANA media types) in which the attachment is available.
+ "A String",
+ ],
+ "name": "A String", # The resource name;
+ },
+ ],
+ "body": { # The content of the note. # The body of the note.
+ "list": { # The list of items for a single list note. # Used if this section's content is a list.
+ "listItems": [ # The items in the list. The number of items must be less than 1,000.
+ { # A single list item in a note's list.
+ "checked": True or False, # Whether this item has been checked off or not.
+ "childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
+ # Object with schema name: ListItem
+ ],
+ "text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ ],
+ },
+ "text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ "createTime": "A String", # Output only. When this note was created.
+ "name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.
+ "permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
+ { # A single permission on the note. Associates a `member` with a `role`.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ ],
+ "title": "A String", # The title of the note. Length must be less than 1,000 characters.
+ "trashTime": "A String", # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
+ "trashed": True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
+ "updateTime": "A String", # Output only. When this note was last modified.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single note.
+ "attachments": [ # Output only. The attachments attached to this note.
+ { # An attachment to a note.
+ "mimeType": [ # The MIME types (IANA media types) in which the attachment is available.
+ "A String",
+ ],
+ "name": "A String", # The resource name;
+ },
+ ],
+ "body": { # The content of the note. # The body of the note.
+ "list": { # The list of items for a single list note. # Used if this section's content is a list.
+ "listItems": [ # The items in the list. The number of items must be less than 1,000.
+ { # A single list item in a note's list.
+ "checked": True or False, # Whether this item has been checked off or not.
+ "childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
+ # Object with schema name: ListItem
+ ],
+ "text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ ],
+ },
+ "text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ "createTime": "A String", # Output only. When this note was created.
+ "name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.
+ "permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
+ { # A single permission on the note. Associates a `member` with a `role`.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ ],
+ "title": "A String", # The title of the note. Length must be less than 1,000 characters.
+ "trashTime": "A String", # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
+ "trashed": True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
+ "updateTime": "A String", # Output only. When this note was last modified.
+}
+
+
+
+
delete(name, x__xgafv=None)
+
Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.
+
+Args:
+ name: string, Required. Name of the note to delete. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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 note.
+
+Args:
+ name: string, Required. Name of the resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single note.
+ "attachments": [ # Output only. The attachments attached to this note.
+ { # An attachment to a note.
+ "mimeType": [ # The MIME types (IANA media types) in which the attachment is available.
+ "A String",
+ ],
+ "name": "A String", # The resource name;
+ },
+ ],
+ "body": { # The content of the note. # The body of the note.
+ "list": { # The list of items for a single list note. # Used if this section's content is a list.
+ "listItems": [ # The items in the list. The number of items must be less than 1,000.
+ { # A single list item in a note's list.
+ "checked": True or False, # Whether this item has been checked off or not.
+ "childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
+ # Object with schema name: ListItem
+ ],
+ "text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ ],
+ },
+ "text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ "createTime": "A String", # Output only. When this note was created.
+ "name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.
+ "permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
+ { # A single permission on the note. Associates a `member` with a `role`.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ ],
+ "title": "A String", # The title of the note. Length must be less than 1,000 characters.
+ "trashTime": "A String", # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
+ "trashed": True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
+ "updateTime": "A String", # Output only. When this note was last modified.
+}
+
+
+
+
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+
Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.
+
+Args:
+ filter: string, Filter for list results. If no filter is supplied, the "-trashed" filter is applied by default. Valid fields to filter by are: - `create_time` - `update_time` - `trash_time` - `trashed` Filter syntax follows the Google AIP filtering spec: https://aip.dev/160
+ pageSize: integer, The maximum number of results to return.
+ pageToken: string, The previous page's `next_page_token` field.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response when listing a page of notes (see KeepService documentation).
+ "nextPageToken": "A String", # Next page's `page_token` field.
+ "notes": [ # A page of notes.
+ { # A single note.
+ "attachments": [ # Output only. The attachments attached to this note.
+ { # An attachment to a note.
+ "mimeType": [ # The MIME types (IANA media types) in which the attachment is available.
+ "A String",
+ ],
+ "name": "A String", # The resource name;
+ },
+ ],
+ "body": { # The content of the note. # The body of the note.
+ "list": { # The list of items for a single list note. # Used if this section's content is a list.
+ "listItems": [ # The items in the list. The number of items must be less than 1,000.
+ { # A single list item in a note's list.
+ "checked": True or False, # Whether this item has been checked off or not.
+ "childListItems": [ # If set, list of list items nested under this list item. Only one level of nesting is allowed.
+ # Object with schema name: ListItem
+ ],
+ "text": { # The block of text for a single text section or list item. # The text of this item. Length must be less than 1,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ ],
+ },
+ "text": { # The block of text for a single text section or list item. # Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters.
+ "text": "A String", # The text of the note. The limits on this vary with the specific field using this type.
+ },
+ },
+ "createTime": "A String", # Output only. When this note was created.
+ "name": "A String", # Output only. The resource name of this note. See general note on identifiers in KeepService.
+ "permissions": [ # Output only. The list of permissions set on the note. Contains at least one entry for the note owner.
+ { # A single permission on the note. Associates a `member` with a `role`.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ ],
+ "title": "A String", # The title of the note. Length must be less than 1,000 characters.
+ "trashTime": "A String", # Output only. If this note has been trashed, when that happened. If trashed, the note will eventually be deleted. If the note is not trashed, this is not set (and the trashed field is false).
+ "trashed": True or False, # Output only. True if this note has been trashed. If trashed, the note will eventually be deleted.
+ "updateTime": "A String", # Output only. When this note was last modified.
+ },
+ ],
+}
+
+
+
+
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/keep_v1.notes.permissions.html b/docs/dyn/keep_v1.notes.permissions.html
new file mode 100644
index 00000000000..a9309120c9b
--- /dev/null
+++ b/docs/dyn/keep_v1.notes.permissions.html
@@ -0,0 +1,178 @@
+
+
+
+
+Instance Methods
+
+ batchCreate(parent, body=None, x__xgafv=None)
+Creates one or more permission on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.
+
+ batchDelete(parent, body=None, x__xgafv=None)
+Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
+
+ close()
+Close httplib2 connections.
+Method Details
+
+
batchCreate(parent, body=None, x__xgafv=None)
+
Creates one or more permission on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.
+
+Args:
+ parent: string, The parent resource shared by all Permissions being created. Format: `notes/{note}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to add one or more permissions on the note. Currently, only the `WRITER` role may be specified. If adding a permission fails, then the entire request fails and no changes are made.
+ "requests": [ # The request message specifying the resources to create.
+ { # The request to add a single permission on the note.
+ "parent": "A String", # Required. The parent note where this permission will be created. Format: `notes/{note}`
+ "permission": { # A single permission on the note. Associates a `member` with a `role`. # Required. The permission to create. One of Permission.email, User.email or Group.email must be supplied.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for creating permissions on a note.
+ "permissions": [ # Permissions created.
+ { # A single permission on the note. Associates a `member` with a `role`.
+ "deleted": True or False, # Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.
+ "email": "A String", # The email associated with the member. If set on create, the email field in the User or Group message must either be empty or match this field. On read, may be unset if the member does not have an associated email.
+ "family": { # Describes a single Google Family. # Output only. The Google Family to which this role applies.
+ },
+ "group": { # Describes a single Group. # Output only. The group to which this role applies.
+ "email": "A String", # The group email.
+ },
+ "name": "A String", # Output only. The resource name.
+ "role": "A String", # The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.
+ "user": { # Describes a single user. # Output only. The user to whom this role applies.
+ "email": "A String", # The user's email.
+ },
+ },
+ ],
+}
+
+
+
+
batchDelete(parent, body=None, x__xgafv=None)
+
Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
+
+Args:
+ parent: string, The parent resource shared by all permissions being deleted. Format: `notes/{note}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to remove one or more permissions from a note. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.
+ "names": [ # Required. The names of the permissions to delete. Format: `notes/{note}/permissions/{permission}`
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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 `{}`.
+}
+
+
+
+
close()
+
Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
index d54b89d4c5b..eb687ae71e7 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html
@@ -86,21 +86,12 @@ Instance Methods
get(name, x__xgafv=None)
Gets details of a single backup.
-
- getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
-Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists backups in a service.
list_next(previous_request, previous_response)
Retrieves the next page of results.
-
- setIamPolicy(resource, body=None, x__xgafv=None)
-Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
-
- testIamPermissions(resource, body=None, x__xgafv=None)
-Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Method Details
close()
@@ -334,54 +325,6 @@
Method Details
}
-
-
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
-
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
-Args:
- resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
- options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
- },
- ],
- "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
- { # Associates members with a role.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "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@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. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
- "A String",
- ],
- "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
- },
- ],
- "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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
- "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
-}
-
-
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists backups in a service.
@@ -491,119 +434,4 @@ Method Details
-
-
setIamPolicy(resource, body=None, x__xgafv=None)
-
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
-
-Args:
- resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for SetIamPolicy method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # 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.
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
- },
- ],
- "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
- { # Associates members with a role.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "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@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. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
- "A String",
- ],
- "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
- },
- ],
- "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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
- "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
- },
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
- },
- ],
- "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
- { # Associates members with a role.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
- "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
- },
- "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@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. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
- "A String",
- ],
- "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
- },
- ],
- "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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
- "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
-}
-
-
-
-
testIamPermissions(resource, body=None, x__xgafv=None)
-
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
-
-Args:
- resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body.
- 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 (https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
- ],
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 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",
- ],
-}
-
-