get(name, x__xgafv=None)
Gets an Endpoint.
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
list(parent, filter=None, gdcZone=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists Endpoints in a Location.
Retrieves the next page of results.
mutateDeployedModel(endpoint, body=None, x__xgafv=None)
Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
+Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an Endpoint.
@@ -809,6 +809,7 @@list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ list(parent, filter=None, gdcZone=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists Endpoints in a Location.
Args:
parent: string, Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}` (required)
filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"`
+ gdcZone: string, Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.
@@ -2621,6 +2631,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -2658,6 +2669,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -2721,7 +2735,7 @@ Method Details
mutateDeployedModel(endpoint, body=None, x__xgafv=None)
- Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
+ Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
Args:
endpoint: string, Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
@@ -2729,7 +2743,7 @@ Method Details
The object takes the form of:
{ # Request message for EndpointService.MutateDeployedModel.
- "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)
+ "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
"minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
@@ -2876,6 +2890,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3101,6 +3116,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3138,6 +3154,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -3345,6 +3364,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3382,6 +3402,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -4604,6 +4627,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -4641,6 +4665,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html
index d389991e21c..aaa1cba70ab 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.html
@@ -727,6 +727,7 @@ Method Details
"huggingFaceAccessToken": "A String", # Optional. The Hugging Face read access token used to access the model artifacts of gated models.
"huggingFaceCacheEnabled": True or False, # Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.
"modelDisplayName": "A String", # Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
+ "modelUserId": "A String", # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
},
"publisherModelName": "A String", # The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
}
diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
index 0b134d870ac..b42f511610f 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html
@@ -169,7 +169,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -341,7 +341,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -520,7 +520,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -705,7 +705,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -905,7 +905,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html
index 128e144add0..738f00355a6 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.html
@@ -87,9 +87,15 @@ Instance Methods
Close httplib2 connections.
+
+ fetchPublisherModelConfig(name, x__xgafv=None)
+Fetches the configs of publisher models.
getCacheConfig(name, x__xgafv=None)
Gets a GenAI cache config.
+
+ setPublisherModelConfig(name, body=None, x__xgafv=None)
+Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.
updateCacheConfig(name, body=None, x__xgafv=None)
Updates a cache config.
@@ -99,6 +105,33 @@ Method Details
Close httplib2 connections.
+
+ fetchPublisherModelConfig(name, x__xgafv=None)
+ Fetches the configs of publisher models.
+
+Args:
+ name: string, Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This message contains configs of a publisher model.
+ "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # The prediction request/response logging config.
+ "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`
+ "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+ },
+ "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.
+ "enabled": True or False, # If logging is enabled or not.
+ "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".
+ "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
+ },
+}
+
+
getCacheConfig(name, x__xgafv=None)
Gets a GenAI cache config.
@@ -119,6 +152,58 @@ Method Details
}
+
+ setPublisherModelConfig(name, body=None, x__xgafv=None)
+ Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.
+
+Args:
+ name: string, Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for EndpointService.SetPublisherModelConfig.
+ "publisherModelConfig": { # This message contains configs of a publisher model. # Required. The publisher model config.
+ "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # The prediction request/response logging config.
+ "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging`
+ "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
+ },
+ "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false.
+ "enabled": True or False, # If logging is enabled or not.
+ "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1".
+ "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1].
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+
updateCacheConfig(name, body=None, x__xgafv=None)
Updates a cache config.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
index ef25e8820ce..545bc9fb358 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html
@@ -623,6 +623,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index f4e4cf06368..59d989cb913 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -124,14 +124,14 @@ Instance Methods
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, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ list(parent, filter=None, gdcZone=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists Endpoints in a Location.
Retrieves the next page of results.
mutateDeployedModel(endpoint, body=None, x__xgafv=None)
-Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
+Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an Endpoint.
@@ -843,6 +843,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -888,6 +889,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -1165,6 +1169,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -2582,6 +2587,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -2627,6 +2633,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -2710,12 +2719,13 @@ Method Details
- list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ list(parent, filter=None, gdcZone=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists Endpoints in a Location.
Args:
parent: string, Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}` (required)
filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"`
+ gdcZone: string, Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.
readMask: string, Optional. Mask specifying which fields to read.
@@ -2893,6 +2903,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -2938,6 +2949,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -3004,7 +3018,7 @@ Method Details
mutateDeployedModel(endpoint, body=None, x__xgafv=None)
- Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
+ Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).
Args:
endpoint: string, Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
@@ -3012,7 +3026,7 @@ Method Details
The object takes the form of:
{ # Request message for EndpointService.MutateDeployedModel.
- "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)
+ "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
"maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.
"minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error.
@@ -3168,6 +3182,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3410,6 +3425,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3455,6 +3471,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -3674,6 +3693,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -3719,6 +3739,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
@@ -5052,6 +5075,7 @@ Method Details
"fasterDeploymentConfig": { # Configuration for faster model deployment. # Configuration for faster model deployment.
"fastTryoutEnabled": True or False, # If true, enable fast tryout feature for this deployed model.
},
+ "gdcConnectedModel": "A String", # GDC pretrained / Gemini model name. The model name is a plain model name, e.g. gemini-1.5-flash-002.
"id": "A String", # Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`.
"model": "A String", # The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed.
"modelVersionId": "A String", # Output only. The version ID of the model that is deployed.
@@ -5097,6 +5121,9 @@ Method Details
"kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
},
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+ "gdcConfig": { # Google Distributed Cloud (GDC) config. # Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.
+ "zone": "A String", # GDC zone. A cluster will be designated for the Vertex AI workload in this zone.
+ },
"genAiAdvancedFeaturesConfig": { # Configuration for GenAiAdvancedFeatures. # Optional. Configuration for GenAiAdvancedFeatures. If the endpoint is serving GenAI models, advanced features like native RAG integration can be configured. Currently, only Model Garden models are supported.
"ragConfig": { # Configuration for Retrieval Augmented Generation feature. # Configuration for Retrieval Augmented Generation feature.
"enableRag": True or False, # If true, enable Retrieval Augmented Generation in ChatCompletion request. Once enabled, the endpoint will be identified as GenAI endpoint and Arthedain router will be used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html
index 50d5f52bfbc..f0804848b5d 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html
@@ -636,6 +636,10 @@ Method Details
The object takes the form of:
{ # Request message for ModelGardenService.Deploy.
+ "customModel": { # The custom model to deploy from model weights in a Google Cloud Storage URI or Model Registry model. # The custom model to deploy from a Google Cloud Storage URI.
+ "gcsUri": "A String", # Immutable. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model).
+ "modelId": "A String", # Optional. Deprecated. Use ModelConfig.model_user_id instead.
+ },
"deployConfig": { # The deploy config to use for the deployment. # Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used.
"dedicatedResources": { # A description of resources that are dedicated to a DeployedModel or DeployedIndex, and that need a higher degree of manual configuration. # Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used.
"autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`.
@@ -807,6 +811,7 @@ Method Details
"huggingFaceAccessToken": "A String", # Optional. The Hugging Face read access token used to access the model artifacts of gated models.
"huggingFaceCacheEnabled": True or False, # Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access.
"modelDisplayName": "A String", # Optional. The user-specified display name of the uploaded model. If not set, a default name will be used.
+ "modelUserId": "A String", # Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. When not provided, Vertex AI will generate a value for this ID. When Model Registry model is provided, this field will be ignored. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen.
},
"publisherModelName": "A String", # The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`.
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
index 8c59151bf55..4a2aef06bae 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
@@ -281,10 +281,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -370,10 +372,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -403,10 +407,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
},
@@ -440,10 +446,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -460,10 +468,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
index a1e55f551b9..5a81d21f136 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
@@ -192,7 +192,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -493,7 +493,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -801,7 +801,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -1115,7 +1115,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
@@ -1444,7 +1444,7 @@ Method Details
"hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
"adapterSize": "A String", # Optional. Adapter size for tuning.
"epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
- "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`.
+ "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
},
"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
"validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
index 3aacaafb4bf..9c353c1a8b0 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
@@ -276,10 +276,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -365,10 +367,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -398,10 +402,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
},
@@ -435,10 +441,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
@@ -455,10 +463,12 @@ Method Details
{ # A session contains a set of actions between users and Vertex agents.
"createTime": "A String", # Output only. Timestamp when the session was created.
"displayName": "A String", # Optional. The display name of the session.
+ "expireTime": "A String", # Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input.
"name": "A String", # Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.
"sessionState": { # Optional. Session specific memory which stores key conversation points.
"a_key": "", # Properties of the object.
},
+ "ttl": "A String", # Optional. Input only. The TTL for this session.
"updateTime": "A String", # Output only. Timestamp when the session was updated.
"userId": "A String", # Required. Immutable. String id provided by the user
}
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html
index 4f41509a8ea..f95b60cdf5d 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.html
@@ -224,6 +224,9 @@ Instance Methods
runAccessReport(entity, body=None, x__xgafv=None)
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
+
+ submitUserDeletion(name, body=None, x__xgafv=None)
+Submits a request for user deletion for a property.
updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates attribution settings on a property.
@@ -926,6 +929,35 @@ Method Details
}
+
+ submitUserDeletion(name, body=None, x__xgafv=None)
+ Submits a request for user deletion for a property.
+
+Args:
+ name: string, Required. The name of the property to submit user deletion for. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SubmitUserDeletion RPC.
+ "appInstanceId": "A String", # Firebase [application instance ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId).
+ "clientId": "A String", # Google Analytics [client ID](https://support.google.com/analytics/answer/11593727).
+ "userId": "A String", # Google Analytics [user ID](https://firebase.google.com/docs/analytics/userid).
+ "userProvidedData": "A String", # [User-provided data](https://support.google.com/analytics/answer/14077171). May contain either one email address or one phone number. Email addresses should be normalized as such: * lowercase * remove periods before @ for gmail.com/googlemail.com addresses * remove all spaces Phone numbers should be normalized as such: * remove all non digit characters * add + prefix
+}
+
+ 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 SubmitUserDeletion RPC.
+ "deletionRequestTime": "A String", # Marks the moment for which all visitor data before this point should be deleted. This is set to the time at which the deletion request was received.
+}
+
+
updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates attribution settings on a property.
diff --git a/docs/dyn/androidenterprise_v1.enrollmentTokens.html b/docs/dyn/androidenterprise_v1.enrollmentTokens.html
index 71d025fe8f2..08abd7037c0 100644
--- a/docs/dyn/androidenterprise_v1.enrollmentTokens.html
+++ b/docs/dyn/androidenterprise_v1.enrollmentTokens.html
@@ -98,6 +98,10 @@ Method Details
{ # A token used to enroll a device.
"duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
"enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
+ "googleAuthenticationOptions": { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment.
+ "authenticationRequirement": "A String", # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token.
+ "requiredAccountEmail": "A String", # [Optional] Specifies the managed Google account that the user must use during enrollment.`AuthenticationRequirement` must be set to`REQUIRED` if this field is set.
+ },
"token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
}
@@ -112,6 +116,10 @@ Method Details
{ # A token used to enroll a device.
"duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.
"enrollmentTokenType": "A String", # [Required] The type of the enrollment token.
+ "googleAuthenticationOptions": { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment.
+ "authenticationRequirement": "A String", # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token.
+ "requiredAccountEmail": "A String", # [Optional] Specifies the managed Google account that the user must use during enrollment.`AuthenticationRequirement` must be set to`REQUIRED` if this field is set.
+ },
"token": "A String", # The token value that's passed to the device and authorizes the device to enroll. This is a read-only field generated by the server.
}
diff --git a/docs/dyn/androidpublisher_v3.monetization.html b/docs/dyn/androidpublisher_v3.monetization.html
index af7589352ca..0f686455423 100644
--- a/docs/dyn/androidpublisher_v3.monetization.html
+++ b/docs/dyn/androidpublisher_v3.monetization.html
@@ -74,6 +74,11 @@
Google Play Android Developer API . monetization
Instance Methods
+
+Returns the onetimeproducts Resource.
+
diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html
new file mode 100644
index 00000000000..2b5e910430b
--- /dev/null
+++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html
@@ -0,0 +1,867 @@
+
+
+
+Google Play Android Developer API . monetization . onetimeproducts
+Instance Methods
+
+Returns the purchaseOptions Resource.
+
+
+ batchDelete(packageName, body=None, x__xgafv=None)
+Deletes one or more one-time products.
+
+ batchGet(packageName, productIds=None, x__xgafv=None)
+Reads one or more one-time products.
+
+ batchUpdate(packageName, body=None, x__xgafv=None)
+Creates or updates one or more one-time products.
+
+ close()
+Close httplib2 connections.
+
+ delete(packageName, productId, latencyTolerance=None, x__xgafv=None)
+Deletes a one-time product.
+
+ get(packageName, productId, x__xgafv=None)
+Reads a single one-time product.
+
+ list(packageName, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all one-time products under a given app.
+
+Retrieves the next page of results.
+
+Creates or updates a one-time product.
+Method Details
+
+ batchDelete(packageName, body=None, x__xgafv=None)
+ Deletes one or more one-time products.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the one-time products should be deleted. Must be equal to the package_name field on all the OneTimeProduct resources. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchDeleteOneTimeProduct.
+ "requests": [ # Required. A list of delete requests of up to 100 elements. All requests must delete different one-time products.
+ { # Request message for deleting a one-time product.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the one-time product to delete.
+ "productId": "A String", # Required. The one-time product ID of the one-time product to delete.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+
+
+ batchGet(packageName, productIds=None, x__xgafv=None)
+ Reads one or more one-time products.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the products should be retrieved. Must be equal to the package_name field on all requests. (required)
+ productIds: string, Required. A list of up to 100 product IDs to retrieve. All IDs must be different. (repeated)
+ 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 the BatchGetOneTimeProducts endpoint.
+ "oneTimeProducts": [ # The list of requested one-time products, in the same order as the request.
+ { # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+ },
+ ],
+}
+
+
+
+ batchUpdate(packageName, body=None, x__xgafv=None)
+ Creates or updates one or more one-time products.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the one-time products should be updated. Must be equal to the package_name field on all the OneTimeProduct resources. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateOneTimeProduct.
+ "requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different one-time products.
+ { # Request message for UpdateOneTimeProduct.
+ "allowMissing": True or False, # Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.
+ "oneTimeProduct": { # A single one-time product for an app. # Required. The one-time product to upsert.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+ },
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "updateMask": "A String", # Required. The list of fields to be updated.
+ },
+ ],
+}
+
+ 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 BatchUpdateOneTimeProduct.
+ "oneTimeProducts": [ # The list of updated one-time products list, in the same order as the request.
+ { # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+ },
+ ],
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ delete(packageName, productId, latencyTolerance=None, x__xgafv=None)
+ Deletes a one-time product.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the one-time product to delete. (required)
+ productId: string, Required. The one-time product ID of the one-time product to delete. (required)
+ latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ Allowed values
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+
+
+ get(packageName, productId, x__xgafv=None)
+ Reads a single one-time product.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the product to retrieve. (required)
+ productId: string, Required. The product ID of the product to retrieve. (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 one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+}
+
+
+
+ list(packageName, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all one-time products under a given app.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the one-time product should be read. (required)
+ pageSize: integer, Optional. The maximum number of one-time product to return. The service may return fewer than this value. If unspecified, at most 50 one-time products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListOneTimeProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOneTimeProducts` must match the call that provided the page token.
+ 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 ListOneTimeProducts.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "oneTimeProducts": [ # The one-time products from the specified app.
+ { # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)
+ Creates or updates a one-time product.
+
+Args:
+ packageName: string, Required. Immutable. Package name of the parent app. (required)
+ productId: string, Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.). (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+}
+
+ allowMissing: boolean, Optional. If set to true, and the one-time product with the given package_name and product_id doesn't exist, the one-time product will be created. If a new one-time product is created, update_mask is ignored.
+ latencyTolerance: string, Optional. The latency tolerance for the propagation of this product upsert. Defaults to latency-sensitive.
+ Allowed values
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
+ PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
+ regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ updateMask: string, Required. The list of fields to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html
new file mode 100644
index 00000000000..bd97044c474
--- /dev/null
+++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html
@@ -0,0 +1,250 @@
+
+
+
+Google Play Android Developer API . monetization . onetimeproducts . purchaseOptions
+Instance Methods
+
+ offers()
+
+Returns the offers Resource.
+
+
+ batchDelete(packageName, productId, body=None, x__xgafv=None)
+Deletes purchase options across one or multiple one-time products. By default this operation will fail if there are any existing offers under the deleted purchase options. Use the force parameter to override the default behavior.
+
+ batchUpdateStates(packageName, productId, body=None, x__xgafv=None)
+Activates or deactivates purchase options across one or multiple one-time products.
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ batchDelete(packageName, productId, body=None, x__xgafv=None)
+ Deletes purchase options across one or multiple one-time products. By default this operation will fail if there are any existing offers under the deleted purchase options. Use the force parameter to override the default behavior.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the purchase options to delete. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all purchase options to delete belong to the same one-time product. If this batch delete spans multiple one-time products, set this field to "-". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchDeletePurchaseOption.
+ "requests": [ # Required. A list of delete requests of up to 100 elements. All requests must delete purchase options from different one-time products.
+ { # Request message for deleting a purchase option.
+ "force": True or False, # Optional. This field has no effect for purchase options with no offers under them. For purchase options with associated offers: * If `force` is set to false (default), an error will be returned. * If `force` is set to true, any associated offers under the purchase option will be deleted.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the purchase option to delete.
+ "productId": "A String", # Required. The parent one-time product (ID) of the purchase option to delete.
+ "purchaseOptionId": "A String", # Required. The purchase option ID of the purchase option to delete.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+
+
+ batchUpdateStates(packageName, productId, body=None, x__xgafv=None)
+ Activates or deactivates purchase options across one or multiple one-time products.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated purchase options. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all updated purchase options belong to the same one-time product. If this batch update spans multiple one-time products, set this field to "-". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdatePurchaseOptionStates.
+ "requests": [ # Required. The update request list of up to 100 elements. All requests must update different purchase options.
+ { # Request message to update the state of a one-time product purchase option.
+ "activatePurchaseOptionRequest": { # Request message for UpdatePurchaseOptionState. # Activates a purchase option. Once activated, the purchase option will be available.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the purchase option to activate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the purchase option to activate.
+ "purchaseOptionId": "A String", # Required. The purchase option ID of the purchase option to activate.
+ },
+ "deactivatePurchaseOptionRequest": { # Request message for UpdatePurchaseOptionState. # Deactivates a purchase option. Once deactivated, the purchase option will become unavailable.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "packageName": "A String", # Required. The parent app (package name) of the purchase option to deactivate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the purchase option to deactivate.
+ "purchaseOptionId": "A String", # Required. The purchase option ID of the purchase option to deactivate.
+ },
+ },
+ ],
+}
+
+ 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 BatchUpdatePurchaseOptionStates.
+ "oneTimeProducts": [ # The list of updated one-time products. This list will match the requests one to one, in the same order.
+ { # A single one-time product for an app.
+ "listings": [ # Required. Set of localized title and description data. Must not have duplicate entries with the same language_code.
+ { # Regional store listing for a one-time product.
+ "description": "A String", # Required. The description of this product in the language of this listing. The maximum length is 200 characters.
+ "languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g., "en-US".
+ "title": "A String", # Required. The title of this product in the language of this listing. The maximum length is 55 characters.
+ },
+ ],
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this one-time product, and returned to the app through the billing library. Purchase options and offers for this product will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. Package name of the parent app.
+ "productId": "A String", # Required. Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must start with a number or lowercase letter, and can contain numbers (0-9), lowercase letters (a-z), underscores (_), and periods (.).
+ "purchaseOptions": [ # Required. The set of purchase options for this one-time product.
+ { # A single purchase option for a one-time product.
+ "buyOption": { # A purchase option that can be bought. # A purchase option that can be bought.
+ "legacyCompatible": True or False, # Optional. Whether this purchase option will be available in legacy PBL flows that do not support one-time products model. Up to one "buy" purchase option can be marked as backwards compatible.
+ "multiQuantityEnabled": True or False, # Optional. Whether this purchase option allows multi-quantity. Multi-quantity allows buyer to purchase more than one item in a single checkout.
+ },
+ "newRegionsConfig": { # Pricing information for any new regions Play may launch in the future. # Pricing information for any new locations Play may launch in the future. If omitted, the purchase option will not be automatically available in any new locations Play may launch in the future.
+ "availability": "A String", # Required. The regional availability for the new regions config. When set to AVAILABLE, the pricing information will be used for any new regions Play may launch in the future.
+ "eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new regions Play may launch in.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this purchase option, and returned to the app through the billing library. Offers for this purchase option will also receive these tags in the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "purchaseOptionId": "A String", # Required. Immutable. The unique identifier of this purchase option. Must be unique within the one-time product. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "regionalPricingAndAvailabilityConfigs": [ # Regional pricing and availability information for this purchase option.
+ { # Regional pricing and availability configuration for a purchase option.
+ "availability": "A String", # The availability of the purchase option.
+ "price": { # Represents an amount of money with its currency type. # The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ },
+ ],
+ "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented.
+ "expirationPeriod": "A String", # Optional. The amount of time the user has after starting consuming the entitlement before it is revoked. Specified in ISO 8601 format.
+ "rentalPeriod": "A String", # Required. The amount of time a user has the entitlement for. Starts at purchase flow completion. Specified in ISO 8601 format.
+ },
+ "state": "A String", # Output only. The state of the purchase option, i.e., whether it's active. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time product purchase options. # Optional. Details about taxes and legal compliance.
+ "withdrawalRightType": "A String", # Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
+ },
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
+ "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
+ "A String",
+ ],
+ },
+ "taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for one-time products. # Details about taxes and legal compliance.
+ "isTokenizedDigitalAsset": True or False, # Whether this one-time product is declared as a product representing a tokenized digital asset.
+ "regionalTaxConfigs": [ # Regional tax configuration.
+ { # Details about taxation in a given geographical region.
+ "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
+ "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
+ "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
+ },
+ ],
+ },
+ },
+ ],
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html
new file mode 100644
index 00000000000..5eaf7a952bb
--- /dev/null
+++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html
@@ -0,0 +1,719 @@
+
+
+
+Google Play Android Developer API . monetization . onetimeproducts . purchaseOptions . offers
+Instance Methods
+
+ activate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+Activates a one-time product offer.
+
+ batchDelete(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+Deletes one or more one-time product offers.
+
+ batchGet(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+Reads one or more one-time product offers.
+
+ batchUpdate(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+Creates or updates one or more one-time product offers.
+
+ batchUpdateStates(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+Updates a batch of one-time product offer states.
+
+ cancel(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+Cancels a one-time product offer.
+
+ close()
+Close httplib2 connections.
+
+ deactivate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+Deactivates a one-time product offer.
+
+ list(packageName, productId, purchaseOptionId, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all offers under a given app, product, or purchase option.
+
+Retrieves the next page of results.
+Method Details
+
+ activate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+ Activates a one-time product offer.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the offer to activate. (required)
+ productId: string, Required. The parent one-time product (ID) of the offer to activate. (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to activate. (required)
+ offerId: string, Required. The offer ID of the offer to activate. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ActivateOneTimeProductOffer.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to activate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to activate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to activate.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to activate.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+}
+
+
+
+ batchDelete(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+ Deletes one or more one-time product offers.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the offers to delete. Must be equal to the package_name field on all the OneTimeProductOffer resources. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all offers to delete belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be deleted. May be specified as '-' to update offers from multiple purchase options. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchDeleteOneTimeProductOffers.
+ "requests": [ # Required. A list of update requests of up to 100 elements. All requests must correspond to different offers.
+ { # Request message for deleting an one-time product offer.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The unique offer ID of the offer to delete.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to delete.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to delete.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to delete.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+
+
+ batchGet(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+ Reads one or more one-time product offers.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for the BatchGetOneTimeProductOffers endpoint.
+ "requests": [ # Required. A list of get requests of up to 100 elements. All requests must retrieve different offers.
+ { # Request message for GetOneTimeProductOffers.
+ "offerId": "A String", # Required. The unique offer ID of the offer to get.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to get.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to get.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to get.
+ },
+ ],
+}
+
+ 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 the BatchGetOneTimeProductOffers endpoint.
+ "oneTimeProductOffers": [ # The list of updated one-time product offers, in the same order as the request.
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ ],
+}
+
+
+
+ batchUpdate(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+ Creates or updates one or more one-time product offers.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated offers. Must be equal to the package_name field on all the updated OneTimeProductOffer resources. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same product. If this request spans multiple one-time products, set this field to "-". (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be updated. May be specified as '-' to update offers from multiple purchase options. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateOneTimeProductOffers.
+ "requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different offers.
+ { # Request message for UpdateOneTimeProductOffer.
+ "allowMissing": True or False, # Optional. If set to true, and the offer with the given package_name, product_id, purchase_option_id and offer_id doesn't exist, an offer will be created. If a new offer is created, the update_mask is ignored.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this offer update. Defaults to latency-sensitive.
+ "oneTimeProductOffer": { # A single offer for a one-time product. # Required. The one-time product offer to update.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "updateMask": "A String", # Required. The list of fields to be updated.
+ },
+ ],
+}
+
+ 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 BatchUpdateOneTimeProductOffers.
+ "oneTimeProductOffers": [ # The list of updated one-time product offers, in the same order as the request.
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ ],
+}
+
+
+
+ batchUpdateStates(packageName, productId, purchaseOptionId, body=None, x__xgafv=None)
+ Updates a batch of one-time product offer states.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the updated one-time product offers. (required)
+ productId: string, Required. The product ID of the parent one-time product, if all updated offers belong to the same one-time product. If this batch update spans multiple one-time products, set this field to "-". (required)
+ purchaseOptionId: string, Required. The purchase option ID of the parent purchase option, if all updated offers belong to the same purchase option. If this batch update spans multiple purchase options, set this field to "-". (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for BatchUpdateOneTimeProductOfferStates.
+ "requests": [ # Required. The update request list of up to 100 elements. All requests must update different offers.
+ { # Request message to update the state of a one-time product offer.
+ "activateOneTimeProductOfferRequest": { # Request message for ActivateOneTimeProductOffer. # Activates an offer. Once activated, the offer is available to users, as long as its conditions are met.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to activate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to activate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to activate.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to activate.
+ },
+ "cancelOneTimeProductOfferRequest": { # Request message for CancelOneTimeProductOffer. # Cancels an offer. Once cancelled, the offer is not available to users. Any pending orders related to this offer will be cancelled. This state transition is specific to pre-orders.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to cancel.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to cancel.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to cancel.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to cancel.
+ },
+ "deactivateOneTimeProductOfferRequest": { # Request message for DeactivateOneTimeProductOffer. # Deactivates an offer. Once deactivated, the offer is no longer available to users. This state transition is specific to discounted offers.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to deactivate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to deactivate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to deactivate.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to deactivate.
+ },
+ },
+ ],
+}
+
+ 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 BatchUpdateOneTimeProductOfferStates.
+ "oneTimeProductOffers": [ # The updated one-time product offers list, in the same order as the request.
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ ],
+}
+
+
+
+ cancel(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+ Cancels a one-time product offer.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the offer to cancel. (required)
+ productId: string, Required. The parent one-time product (ID) of the offer to cancel. (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to cancel. (required)
+ offerId: string, Required. The offer ID of the offer to cancel. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for CancelOneTimeProductOffer.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to cancel.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to cancel.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to cancel.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to cancel.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ deactivate(packageName, productId, purchaseOptionId, offerId, body=None, x__xgafv=None)
+ Deactivates a one-time product offer.
+
+Args:
+ packageName: string, Required. The parent app (package name) of the offer to deactivate. (required)
+ productId: string, Required. The parent one-time product (ID) of the offer to deactivate. (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) of the offer to deactivate. (required)
+ offerId: string, Required. The offer ID of the offer to deactivate. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for DeactivateOneTimeProductOffer.
+ "latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.
+ "offerId": "A String", # Required. The offer ID of the offer to deactivate.
+ "packageName": "A String", # Required. The parent app (package name) of the offer to deactivate.
+ "productId": "A String", # Required. The parent one-time product (ID) of the offer to deactivate.
+ "purchaseOptionId": "A String", # Required. The parent purchase option (ID) of the offer to deactivate.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+}
+
+
+
+ list(packageName, productId, purchaseOptionId, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all offers under a given app, product, or purchase option.
+
+Args:
+ packageName: string, Required. The parent app (package name) for which the offers should be read. (required)
+ productId: string, Required. The parent one-time product (ID) for which the offers should be read. May be specified as '-' to read all offers under an app. (required)
+ purchaseOptionId: string, Required. The parent purchase option (ID) for which the offers should be read. May be specified as '-' to read all offers under a one-time product or an app. Must be specified as '-' if product_id is specified as '-'. (required)
+ pageSize: integer, Optional. The maximum number of offers to return. The service may return fewer than this value. If unspecified, at most 50 offers will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListOneTimeProductsOffers` call. Provide this to retrieve the subsequent page. When paginating, product_id, package_name and purchase_option_id provided to `ListOneTimeProductsOffersRequest` must match the call that provided the page token.
+ 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 ListOneTimeProductOffers.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "oneTimeProductOffers": [ # The one_time_product offers from the specified request.
+ { # A single offer for a one-time product.
+ "discountedOffer": { # Configuration specific to discounted offers. # A discounted offer.
+ "endTime": "A String", # Time when the offer will stop being available.
+ "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.
+ "startTime": "A String", # Time when the offer will start being available.
+ },
+ "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.
+ "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library.
+ { # Represents a custom tag specified for a product offer.
+ "tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
+ },
+ ],
+ "packageName": "A String", # Required. Immutable. The package name of the app the parent product belongs to.
+ "preOrderOffer": { # Configuration specific to pre-order offers. # A pre-order offer.
+ "endTime": "A String", # Required. Time when the pre-order will stop being available.
+ "priceChangeBehavior": "A String", # Required. Immutable. Specifies how price changes affect pre-existing pre-orders.
+ "releaseTime": "A String", # Required. Time on which the product associated with the pre-order will be released and the pre-order orders fulfilled.
+ "startTime": "A String", # Required. Time when the pre-order will start being available.
+ },
+ "productId": "A String", # Required. Immutable. The ID of the parent product this offer belongs to.
+ "purchaseOptionId": "A String", # Required. Immutable. The ID of the purchase option to which this offer is an extension.
+ "regionalPricingAndAvailabilityConfigs": [ # Set of regional pricing and availability information for this offer. Must not have duplicate entries with the same region_code.
+ { # Regional pricing and availability configuration for a one-time product offer.
+ "absoluteDiscount": { # Represents an amount of money with its currency type. # The absolute value of the discount that is subtracted from the purchase option price. It should be between 0 and the purchase option price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "availability": "A String", # Required. The availability for this region.
+ "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used.
+ },
+ "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US".
+ "relativeDiscount": 3.14, # The fraction of the purchase option price that the user pays for this offer. For example, if the purchase option price for this region is $12, then a 50% discount would correspond to a price of $6. The discount must be specified as a fraction strictly larger than 0 and strictly smaller than 1. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region.
+ },
+ ],
+ "regionsVersion": { # The version of the available regions being used for the specified resource. # Output only. The version of the regions configuration that was used to generate the one-time product offer.
+ "version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available.
+ },
+ "state": "A String", # Output only. The current state of this offer. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.
+ },
+ ],
+}
+
+
+
+ list_next()
+ 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/apigee_v1.organizations.environments.apis.revisions.debugsessions.data.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.data.html
index caa10d7b56e..d1e2ead425f 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.data.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.data.html
@@ -91,7 +91,7 @@ Method Details
Gets the debug data from a transaction.
Args:
- name: string, Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+ name: string, Required. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debug_session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html
index 9d824733426..1377380c6a8 100644
--- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html
+++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html
@@ -165,7 +165,7 @@ Method Details
Retrieves a debug session.
Args:
- name: string, Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+ name: string, Required. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debug_session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -191,8 +191,8 @@ Method Details
Args:
parent: string, Required. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
- pageSize: integer, Maximum number of debug sessions to return. The page size defaults to 25.
- pageToken: string, Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.
+ pageSize: integer, Optional. Maximum number of debug sessions to return. The page size defaults to 25.
+ pageToken: string, Optional. Page token, returned from a previous ListDebugSessions call, that you can use to retrieve the next page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html b/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html
index e8ac1641093..8382b6c9e64 100644
--- a/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html
+++ b/docs/dyn/apigee_v1.organizations.securityMonitoringConditions.html
@@ -299,7 +299,7 @@ Method Details
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
}
- updateMask: string, Optional. The list of fields to update. Valid fields to update are `profile`, `scope`, `include_all_resources`, `include`, and `exclude`.
+ updateMask: string, Optional. The list of fields to update. Valid fields to update are `include_all_resources` and `include`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
index e207331c2ba..91aa317ebf2 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
@@ -116,7 +116,7 @@ Method Details
The object takes the form of:
{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
@@ -246,7 +246,7 @@ Method Details
An object of the form:
{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
@@ -316,7 +316,7 @@ Method Details
{ # The response message for getting a list of `BackupPlan`.
"backupPlans": [ # The list of `BackupPlans` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan
{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
@@ -395,7 +395,7 @@ Method Details
The object takes the form of:
{ # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
index 2f54f2990b7..222385a7d34 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
@@ -108,7 +108,7 @@ Method Details
{ # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
"backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
@@ -182,7 +182,7 @@ Method Details
"backupPlanRevisions": [ # The list of `BackupPlanRevisions` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
{ # `BackupPlanRevision` represents a snapshot of a `BackupPlan` at a point in time.
"backupPlanSnapshot": { # A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. # The Backup Plan being encompassed by this revision.
- "backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
+ "backupRules": [ # Optional. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message if on_demand_retention_limit_days is not set.
{ # `BackupRule` binds the backup schedule to a retention policy.
"backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
"ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html
index 8ed187233fd..18296c299d5 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html
@@ -284,7 +284,6 @@ Method Details
},
"lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
- "lastSuccessfulLogBackupConsistencyTime": "A String", # Output only. If the last log backup were successful, this field has the consistency date.
},
"backupCount": "A String", # Number of backups in the data source.
"configState": "A String", # Output only. The backup configuration state.
@@ -415,7 +414,6 @@ Method Details
},
"lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
- "lastSuccessfulLogBackupConsistencyTime": "A String", # Output only. If the last log backup were successful, this field has the consistency date.
},
"backupCount": "A String", # Number of backups in the data source.
"configState": "A String", # Output only. The backup configuration state.
@@ -526,7 +524,6 @@ Method Details
},
"lastBackupState": "A String", # Output only. The status of the last backup to this BackupVault
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. If the last backup were successful, this field has the consistency date.
- "lastSuccessfulLogBackupConsistencyTime": "A String", # Output only. If the last log backup were successful, this field has the consistency date.
},
"backupCount": "A String", # Number of backups in the data source.
"configState": "A String", # Output only. The backup configuration state.
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index 61c0150dfab..3e245a2797f 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -697,6 +697,7 @@ Method Details
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
+ "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
@@ -1424,6 +1425,7 @@ Method Details
"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
"totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
+ "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
@@ -2161,6 +2163,7 @@ Method Details
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
+ "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
@@ -2888,6 +2891,7 @@ Method Details
"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
"totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
+ "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
@@ -3706,6 +3710,7 @@ Method Details
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
+ "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
@@ -4433,6 +4438,7 @@ Method Details
"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
"totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
+ "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
@@ -5141,6 +5147,7 @@ Method Details
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
+ "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
@@ -5868,6 +5875,7 @@ Method Details
"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
"totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
+ "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
@@ -6601,6 +6609,7 @@ Method Details
},
"externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs.
{ # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.
+ "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility.
"bytesBilled": "A String", # External service cost in terms of bigquery bytes billed.
"bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed.
"externalService": "A String", # External service name.
@@ -7328,6 +7337,7 @@ Method Details
"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job.
"totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
"totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job.
+ "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU".
"totalSlotMs": "A String", # Output only. Slot-milliseconds for the job.
"transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
"undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation.
diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html
index c9d0ce3341c..33de22dc5e4 100644
--- a/docs/dyn/chat_v1.spaces.html
+++ b/docs/dyn/chat_v1.spaces.html
@@ -159,6 +159,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -234,6 +235,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -308,6 +310,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -407,6 +410,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -488,6 +492,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -573,6 +578,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -664,6 +670,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -739,6 +746,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -826,6 +834,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -938,6 +947,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -1012,6 +1022,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
diff --git a/docs/dyn/chat_v1.spaces.members.html b/docs/dyn/chat_v1.spaces.members.html
index 683b39283eb..0b018530209 100644
--- a/docs/dyn/chat_v1.spaces.members.html
+++ b/docs/dyn/chat_v1.spaces.members.html
@@ -85,10 +85,10 @@ Instance Methods
Deletes a membership. For an example, see [Remove a user or a Google Chat app from a space](https://developers.google.com/workspace/chat/delete-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) and the authorization scope: - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.memberships.app` (to remove the calling app from the space) - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and the following authorization scope is used: - `https://www.googleapis.com/auth/chat.admin.memberships` App authentication is not supported for the following use cases: - Removing a Google Group from a space. - Removing a Chat app from a space. To delete memberships for space managers, the requester must be a space manager. If you're using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) the Chat app must be the space creator.
get(name, useAdminAccess=None, x__xgafv=None)
-Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
+Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
-Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
+Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
Retrieves the next page of results.
@@ -192,7 +192,7 @@ Method Details
get(name, useAdminAccess=None, x__xgafv=None)
- Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
+ Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
Args:
name: string, Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. (required)
@@ -226,7 +226,7 @@ Method Details
list(parent, filter=None, pageSize=None, pageToken=None, showGroups=None, showInvited=None, useAdminAccess=None, x__xgafv=None)
- Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
+ Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships`
Args:
parent: string, Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space} (required)
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index fd3955ac318..ec12d73177d 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -1446,8 +1446,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -1460,8 +1460,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -1473,6 +1477,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -2352,6 +2361,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -3756,8 +3766,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -3770,8 +3780,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -3783,6 +3797,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -4662,6 +4681,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -6084,8 +6104,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -6098,8 +6118,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -6111,6 +6135,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -6990,6 +7019,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -8400,8 +8430,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -8414,8 +8444,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -8427,6 +8461,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -9306,6 +9345,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -10721,8 +10761,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -10735,8 +10775,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -10748,6 +10792,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -11627,6 +11676,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -13025,8 +13075,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -13039,8 +13089,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -13052,6 +13106,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -13931,6 +13990,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -15329,8 +15389,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -15343,8 +15403,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -15356,6 +15420,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -16235,6 +16304,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -17633,8 +17703,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -17647,8 +17717,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -17660,6 +17734,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -18539,6 +18618,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index 912a1caca16..c943e23ea5f 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -1561,8 +1561,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -1575,8 +1575,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -1588,6 +1592,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -2467,6 +2476,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -3860,8 +3870,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -3874,8 +3884,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -3887,6 +3901,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -4766,6 +4785,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -6159,8 +6179,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -6173,8 +6193,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -6186,6 +6210,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -7065,6 +7094,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -8456,8 +8486,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -8470,8 +8500,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -8483,6 +8517,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -9362,6 +9401,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -10751,8 +10791,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -10765,8 +10805,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -10778,6 +10822,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -11657,6 +11706,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -13046,8 +13096,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -13060,8 +13110,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -13073,6 +13127,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -13952,6 +14011,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -14136,6 +14196,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -14204,6 +14265,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -15740,8 +15802,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -15754,8 +15816,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -15767,6 +15833,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -16646,6 +16717,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -18039,8 +18111,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -18053,8 +18125,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -18066,6 +18142,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -18945,6 +19026,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -20338,8 +20420,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -20352,8 +20434,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -20365,6 +20451,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -21244,6 +21335,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -22635,8 +22727,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -22649,8 +22741,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -22662,6 +22758,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -23541,6 +23642,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -24930,8 +25032,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -24944,8 +25046,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -24957,6 +25063,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -25836,6 +25947,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -27225,8 +27337,8 @@ Method Details
},
"url": "A String", # Input only. URL for users to authenticate or configure. (Only for `REQUEST_CONFIG` response types.)
},
- "annotations": [ # Output only. Annotations associated with the `text` in this message.
- { # Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
+ "annotations": [ # Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0.
+ { # Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with a `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```
"customEmojiMetadata": { # Annotation metadata for custom emoji. # The metadata for a custom emoji.
"customEmoji": { # Represents a [custom emoji](https://support.google.com/chat/answer/12800149). # The custom emoji.
"emojiName": "A String", # Optional. Immutable. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: `:valid-emoji-name:`
@@ -27239,8 +27351,12 @@ Method Details
"uid": "A String", # Output only. Unique key for the custom emoji resource.
},
},
- "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to.
- "richLinkMetadata": { # A rich link to a resource. # The metadata for a rich link.
+ "length": 42, # Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.
+ "richLinkMetadata": { # A rich link to a resource. Rich links can be associated with the plain-text body of the message or represent chips that link to Google Workspace resources like Google Docs or Sheets with a with `start_index` and `length` of 0. # The metadata for a rich link.
+ "calendarEventLinkData": { # Data for Calendar event links. # Data for a calendar event link.
+ "calendarId": "A String", # The [Calendar identifier](https://developers.google.com/workspace/calendar/api/v3/reference/calendars) of the linked Calendar.
+ "eventId": "A String", # The [Event identifier](https://developers.google.com/workspace/calendar/api/v3/reference/events) of the linked Calendar event.
+ },
"chatSpaceLinkData": { # Data for Chat space links. # Data for a chat space link.
"message": "A String", # The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`
"space": "A String", # The space of the linked Chat space resource. Format: `spaces/{space}`
@@ -27252,6 +27368,11 @@ Method Details
},
"mimeType": "A String", # The mime type of the linked Google Drive resource.
},
+ "meetSpaceLinkData": { # Data for Meet space links. # Data for a meet space link.
+ "huddleStatus": "A String", # Optional. Output only. If the Meet is a Huddle, indicates the status of the huddle. Otherwise, this is unset.
+ "meetingCode": "A String", # Meeting code of the linked Meet space.
+ "type": "A String", # Indicates the type of the Meet space.
+ },
"richLinkType": "A String", # The rich link type.
"uri": "A String", # The URI of this link.
},
@@ -28131,6 +28252,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -28315,6 +28437,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
@@ -28383,6 +28506,7 @@ Method Details
},
"adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
"createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+ "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. [Developer Preview](https://developers.google.com/workspace/preview).
"displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
"externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
"importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
index a7264f57bd6..96d5f6d4d0a 100644
--- a/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
+++ b/docs/dyn/chromemanagement_v1.customers.telemetry.events.html
@@ -98,7 +98,7 @@ Method Details
filter: string, Optional. Only include resources that match the filter. Although this parameter is currently optional, this parameter will be required- please specify at least 1 event type. Supported filter fields: - device_id - user_id - device_org_unit_id - user_org_unit_id - timestamp - event_type The "timestamp" filter accepts either the Unix Epoch milliseconds format or the RFC3339 UTC "Zulu" format with nanosecond resolution and up to nine fractional digits. Both formats should be surrounded by simple double quotes. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", "1679283943823".
pageSize: integer, Optional. Maximum number of results to return. Default value is 100. Maximum value is 1000.
pageToken: string, Optional. Token to specify next page in the list.
- readMask: string, Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event
+ readMask: string, Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event - external_displays_event
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html
index cd840bd3204..91a29d11bc4 100644
--- a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html
+++ b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html
@@ -128,7 +128,7 @@ Method Details
"privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool.
"networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
"publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.
- "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.
+ "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface.
},
"workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size.
@@ -241,7 +241,7 @@ Method Details
"privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool.
"networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
"publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.
- "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.
+ "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface.
},
"workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size.
@@ -291,7 +291,7 @@ Method Details
"privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool.
"networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
"publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.
- "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.
+ "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface.
},
"workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size.
@@ -347,7 +347,7 @@ Method Details
"privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool.
"networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
"publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect.
- "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.
+ "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface.
},
"workerConfig": { # Defines the configuration to be used for creating workers in the pool. # Machine configuration for the workers in the pool.
"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
index 54f540035ac..5fbb902f8a6 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
@@ -120,7 +120,7 @@ Instance Methods
list_next()
Retrieves the next page of results.
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)
Updates a conversation.
upload(parent, body=None, x__xgafv=None)
@@ -1522,13 +1522,14 @@ Method Details
"customerChannel": 42, # Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
},
"gcsSource": { # Configuration for Cloud Storage bucket sources. # A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
- "audioBucketUri": "A String", # Optional. The Cloud Storage path to the conversation audio file if already transcribed. Note that: [1] Don't set this field if the audio is not transcribed. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.
- "bucketObjectType": "A String", # Optional. Specifies the type of the objects in `bucket_uri`.
- "bucketUri": "A String", # Required. The Cloud Storage bucket containing source objects.
+ "audioBucketUri": "A String", # Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.
+ "bucketObjectType": "A String", # Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.
+ "bucketUri": "A String", # Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.
"customMetadataKeys": [ # Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.
"A String",
],
"metadataBucketUri": "A String", # Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.
+ "transcriptBucketUri": "A String", # Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.
},
"parent": "A String", # Required. The parent resource for new conversations.
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
@@ -2001,7 +2002,7 @@ Method Details
- patch(name, body=None, updateMask=None, x__xgafv=None)
+ patch(name, allowMissing=None, body=None, updateMask=None, x__xgafv=None)
Updates a conversation.
Args:
@@ -2393,6 +2394,7 @@ Method Details
"updateTime": "A String", # Output only. The most recent time at which the conversation was updated.
}
+ allowMissing: boolean, Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored.
updateMask: string, The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or `data_source.dialogflow_source.audio_uri`
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
index 8e3c11bd2da..cc25f53e209 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
@@ -727,13 +727,14 @@ Method Details
"customerChannel": 42, # Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
},
"gcsSource": { # Configuration for Cloud Storage bucket sources. # A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
- "audioBucketUri": "A String", # Optional. The Cloud Storage path to the conversation audio file if already transcribed. Note that: [1] Don't set this field if the audio is not transcribed. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.
- "bucketObjectType": "A String", # Optional. Specifies the type of the objects in `bucket_uri`.
- "bucketUri": "A String", # Required. The Cloud Storage bucket containing source objects.
+ "audioBucketUri": "A String", # Optional. The Cloud Storage path to the conversation audio file. Note that: [1] Audio files will be transcribed if not already. [2] Audio files and transcript files must be in separate buckets / folders. [3] A source file and its corresponding audio file must share the same name to be properly ingested, E.g. `gs://bucket/transcript/conversation1.json` and `gs://bucket/audio/conversation1.mp3`.
+ "bucketObjectType": "A String", # Optional. Specifies the type of the objects in `bucket_uri`. Avoid passing this. This is inferred from the `transcript_bucket_uri`, `audio_bucket_uri`.
+ "bucketUri": "A String", # Optional. The Cloud Storage bucket containing source objects. Avoid passing this. Pass this through one of `transcript_bucket_uri` or `audio_bucket_uri`.
"customMetadataKeys": [ # Optional. Custom keys to extract as conversation labels from metadata files in `metadata_bucket_uri`. Keys not included in this field will be ignored. Note that there is a limit of 100 labels per conversation.
"A String",
],
"metadataBucketUri": "A String", # Optional. The Cloud Storage path to the conversation metadata. Note that: [1] Metadata files are expected to be in JSON format. [2] Metadata and source files (transcripts or audio) must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.
+ "transcriptBucketUri": "A String", # Optional. The Cloud Storage path to the conversation transcripts. Note that: [1] Transcript files are expected to be in JSON format. [2] Transcript, audio, metadata files must be in separate buckets / folders. [3] A source file and its corresponding metadata file must share the same name to be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and `gs://bucket/metadata/conversation1.json`.
},
"parent": "A String", # Required. The parent resource for new conversations.
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist. # Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
diff --git a/docs/dyn/content_v2_1.conversionsources.html b/docs/dyn/content_v2_1.conversionsources.html
index e0573e4645c..2b1c9085dac 100644
--- a/docs/dyn/content_v2_1.conversionsources.html
+++ b/docs/dyn/content_v2_1.conversionsources.html
@@ -374,7 +374,7 @@ Method Details
"state": "A String", # Output only. Current state of this conversion source. Can't be edited through the API.
}
- updateMask: string, Optional. List of fields being updated.
+ updateMask: string, Optional. List of fields being updated. The following fields can be updated: `attribution_settings`, `display_name`, `currency_code`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html
index 111de585b88..946396972ec 100644
--- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html
+++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.tags.html
@@ -312,7 +312,7 @@ Method Details
The object takes the form of:
{ # Request message for ReconcileTags.
- "forceDeleteMissing": True or False, # If set to `true`, deletes entry tags related to a tag template not listed in the tags source from an entry. If set to `false`, unlisted tags are retained.
+ "forceDeleteMissing": True or False,
"tagTemplate": "A String", # Required. The name of the tag template, which is used for reconciliation.
"tags": [ # A list of tags to apply to an entry. A tag can specify a tag template, which must be the template specified in the `ReconcileTagsRequest`. The sole entry and each of its columns must be mentioned at most once.
{ # Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
diff --git a/docs/dyn/discoveryengine_v1.projects.html b/docs/dyn/discoveryengine_v1.projects.html
index a0cab0f983d..29423e4cde3 100644
--- a/docs/dyn/discoveryengine_v1.projects.html
+++ b/docs/dyn/discoveryengine_v1.projects.html
@@ -108,6 +108,9 @@ Method Details
{ # Request for ProjectService.ProvisionProject method.
"acceptDataUseTerms": True or False, # Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).
"dataUseTermsVersion": "A String", # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
+ "saasParams": { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
+ "acceptBizQos": True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
+ },
}
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.cmekConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.cmekConfigs.html
index cf8596b981c..be3a054d4ce 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.cmekConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.cmekConfigs.html
@@ -146,8 +146,8 @@ Method Details
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -178,8 +178,8 @@ Method Details
"cmekConfigs": [ # All the customer's CmekConfigs.
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -205,8 +205,8 @@ Method Details
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
index ccf727bcab3..cb231f0ab9d 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
@@ -236,8 +236,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -446,8 +446,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -612,8 +612,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -766,8 +766,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -902,8 +902,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
index db1d8b6f959..94a40c74a01 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
@@ -638,7 +638,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true"
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: "user_pseudo_id = some_id" "display_name = \"some_name\"" "starred = true" "is_pinned=true AND (NOT labels:hidden)" "create_time > \"1970-01-01T12:00:00Z\""
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
index c3a5195cd9f..a8a6b201959 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
@@ -77,6 +77,12 @@ Instance Methods
Close httplib2 connections.
+
+Gets an Assistant.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates an Assistant
streamAssist(name, body=None, x__xgafv=None)
Assists the user with a query in a streaming fashion.
@@ -86,6 +92,52 @@ Method Details
Close httplib2 connections.
+
+ get(name, x__xgafv=None)
+ Gets an Assistant.
+
+Args:
+ name: string, Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Discovery Engine Assistant resource.
+ "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an Assistant
+
+Args:
+ name: string, Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Discovery Engine Assistant resource.
+ "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ updateMask: string, The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Discovery Engine Assistant resource.
+ "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+
streamAssist(name, body=None, x__xgafv=None)
Assists the user with a query in a streaming fashion.
@@ -107,7 +159,6 @@ Method Details
"toolsSpec": { # Specification of tools that are used to serve the request. # Optional. Specification of tools that are used to serve the request.
"imageGenerationSpec": { # Specification of the image generation tool. # Optional. Specification of the image generation tool.
},
- "toolRegistry": "A String", # Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}`
"vertexAiSearchSpec": { # Specification of the Vertex AI Search tool. # Optional. Specification of the Vertex AI Search tool.
"dataStoreSpecs": [ # Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.
{ # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
@@ -135,13 +186,11 @@ Method Details
"filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
},
],
- "disabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default.
"filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
},
"videoGenerationSpec": { # Specification of the video generation tool. # Optional. Specification of the video generation tool.
},
"webGroundingSpec": { # Specification of the web grounding tool. # Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.
- "enabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled.
},
},
"userMetadata": { # User metadata of the request. # Optional. Information about the user initiating the query.
@@ -163,6 +212,7 @@ Method Details
"assistSkippedReasons": [ # Reasons for not answering the assist call.
"A String",
],
+ "name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"replies": [ # Replies of the assistant.
{ # One part of the multi-part response of the assist call.
"groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
index bed838b459e..e0af3f3c865 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
@@ -638,7 +638,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true"
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: "user_pseudo_id = some_id" "display_name = \"some_name\"" "starred = true" "is_pinned=true AND (NOT labels:hidden)" "create_time > \"1970-01-01T12:00:00Z\""
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
index 00b173d8fed..34fc81369c6 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
@@ -228,8 +228,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -438,8 +438,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -604,8 +604,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -758,8 +758,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -894,8 +894,8 @@ Method Details
},
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the DataStore.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html
index ee2b684fabb..08967ff3991 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html
@@ -638,7 +638,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true"
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: "user_pseudo_id = some_id" "display_name = \"some_name\"" "starred = true" "is_pinned=true AND (NOT labels:hidden)" "create_time > \"1970-01-01T12:00:00Z\""
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html
index 230ccfc40ca..6eb42801ab7 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.html
@@ -155,8 +155,8 @@ Method Details
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -180,8 +180,8 @@ Method Details
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.html b/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.html
index 3dc8e6f088d..c1e6b07efbf 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.html
@@ -127,8 +127,8 @@ Method Details
{ # Identity Mapping Store which contains Identity Mapping Entries.
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the Identity Mapping Store.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -157,8 +157,8 @@ Method Details
{ # Identity Mapping Store which contains Identity Mapping Entries.
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the Identity Mapping Store.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -226,8 +226,8 @@ Method Details
{ # Identity Mapping Store which contains Identity Mapping Entries.
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the Identity Mapping Store.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
@@ -314,8 +314,8 @@ Method Details
{ # Identity Mapping Store which contains Identity Mapping Entries.
"cmekConfig": { # Configurations used to enable CMEK data encryption with Cloud KMS keys. # Output only. CMEK-related information for the Identity Mapping Store.
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
- "kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
- "kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
+ "kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+ "kmsKeyVersion": "A String", # Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html
index 999926a374d..e95dc206b4d 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.rankingConfigs.html
@@ -99,7 +99,7 @@ Method Details
"ignoreRecordDetailsInResponse": True or False, # If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
"model": "A String", # The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.
"query": "A String", # The query to use.
- "records": [ # Required. A list of records to rank. At most 200 records to rank.
+ "records": [ # Required. A list of records to rank.
{ # Record message for RankService.Rank method.
"content": "A String", # The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
"id": "A String", # The unique ID to represent the record.
diff --git a/docs/dyn/discoveryengine_v1alpha.media.html b/docs/dyn/discoveryengine_v1alpha.media.html
index 305787e875f..cb2daa4aab2 100644
--- a/docs/dyn/discoveryengine_v1alpha.media.html
+++ b/docs/dyn/discoveryengine_v1alpha.media.html
@@ -78,8 +78,11 @@ Instance Methods
close()
Close httplib2 connections.
- upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
-Uploads a file for Notebook LM to use. Creates a Source.
+ download(name, fileId=None, viewId=None, x__xgafv=None)
+Downloads a file from the session.
+
+ download_media(name, fileId=None, viewId=None, x__xgafv=None)
+Downloads a file from the session.
Method Details
close()
@@ -87,274 +90,120 @@ Method Details
- upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
- Uploads a file for Notebook LM to use. Creates a Source.
+ download(name, fileId=None, viewId=None, x__xgafv=None)
+ Downloads a file from the session.
Args:
- parent: string, Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
- body: object, The request body.
- The object takes the form of:
+ name: string, Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` (required)
+ fileId: string, Required. The ID of the file to be downloaded.
+ viewId: string, Optional. The ID of the view to be downloaded.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
-{ # Request for the SourceService.UploadSourceFile method.
- "blob": { # A reference to data stored on the filesystem, on GFS or in blobstore. # Information about the file being uploaded.
- "algorithm": "A String", # Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
- "bigstoreObjectRef": "A String", # Use object_id instead.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
- { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- ],
- "contentType": "A String", # MIME type of the data
- "contentTypeInfo": { # Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. # Extended content type information provided for Scotty uploads.
- "bestGuess": "A String", # Scotty's best guess of what the content type of the file is.
- "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
- "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client.
- "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
- "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
- "diffChecksumsResponse": { # Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
- "checksumsLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- "chunkSizeBytes": "A String", # The chunk size of checksums. Must be a multiple of 256KB.
- "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # If set, calculate the checksums based on the contents and return them to the caller.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
+Returns:
+ An object of the form:
+
+ { # A reference to data stored on the filesystem, on GFS or in blobstore.
+ "algorithm": "A String", # Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
+ "bigstoreObjectRef": "A String", # Use object_id instead.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+ },
+ "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
+ { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "objectSizeBytes": "A String", # The total size of the server object.
- "objectVersion": "A String", # The object version of the object the checksums are being returned for.
- },
- "diffDownloadResponse": { # Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
- "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The original object location.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
},
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
},
- "diffUploadRequest": { # A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_REQUEST.
- "checksumsInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
+ ],
+ "contentType": "A String", # MIME type of the data
+ "contentTypeInfo": { # Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. # Extended content type information provided for Scotty uploads.
+ "bestGuess": "A String", # Scotty's best guess of what the content type of the file is.
+ "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
+ "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client.
+ "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
+ "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
+ },
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
+ "diffChecksumsResponse": { # Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
+ "checksumsLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "objectInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
},
- "objectVersion": "A String", # The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
},
- "diffUploadResponse": { # Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_RESPONSE.
- "objectVersion": "A String", # The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
- "originalObject": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
+ "chunkSizeBytes": "A String", # The chunk size of checksums. Must be a multiple of 256KB.
+ "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # If set, calculate the checksums based on the contents and return them to the caller.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
+ },
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
},
- "diffVersionResponse": { # Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_VERSION_RESPONSE.
- "objectSizeBytes": "A String", # The total size of the server object.
- "objectVersion": "A String", # The version of the object stored at the server.
- },
- "downloadParameters": { # Parameters specific to media downloads. # Parameters for a media download.
- "allowGzipCompression": True or False, # A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
- "ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
- },
- "filename": "A String", # Original file name
- "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
- "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # Scotty-provided MD5 hash for an upload.
- "mediaId": "A String", # Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # Scotty-provided SHA1 hash for an upload.
- "sha256Hash": "A String", # Scotty-provided SHA256 hash for an upload.
- "timestamp": "A String", # Time at which the media data was last updated, in milliseconds since UNIX epoch
- "token": "A String", # A unique fingerprint/version id for the media data
+ "objectSizeBytes": "A String", # The total size of the server object.
+ "objectVersion": "A String", # The object version of the object the checksums are being returned for.
},
- "mediaRequestInfo": { # Extra information added to operations that support Scotty media requests. # Media upload request metadata.
- "currentBytes": "A String", # The number of current bytes uploaded or downloaded.
- "customData": "A String", # Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
- "diffObjectVersion": "A String", # Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.
- "finalStatus": 42, # The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929
- "notificationType": "A String", # The type of notification received from Scotty.
- "requestId": "A String", # The Scotty request ID.
- "requestReceivedParamsServingInfo": "A String", # The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()
- "totalBytes": "A String", # The total size of the file.
- "totalBytesIsEstimated": True or False, # Whether the total bytes field contains an estimated data.
- },
- "sourceId": "A String", # The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.
-}
-
- media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
- media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response for the SourceService.UploadSourceFile method.
- "mediaResponseInfo": { # This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 } # Media upload response metadata.
- "customData": "A String", # Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
- "dataStorageTransform": "A String", # Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
- "destinationBlobMintIndex": 42, # For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
- "dynamicDropTarget": "A String", # Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
- "dynamicDropzone": "A String", # Specifies the Scotty dropzone to use for uploads.
- "mediaForDiff": { # A reference to data stored on the filesystem, on GFS or in blobstore. # Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
- "algorithm": "A String", # Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
- "bigstoreObjectRef": "A String", # Use object_id instead.
+ "diffDownloadResponse": { # Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
+ "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The original object location.
"blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
"blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
"blobGeneration": "A String", # The blob generation id.
@@ -363,208 +212,86 @@ Method Details
"readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
"uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
- { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- ],
- "contentType": "A String", # MIME type of the data
- "contentTypeInfo": { # Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. # Extended content type information provided for Scotty uploads.
- "bestGuess": "A String", # Scotty's best guess of what the content type of the file is.
- "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
- "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client.
- "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
- "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
- },
"cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
- "diffChecksumsResponse": { # Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
- "checksumsLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- "chunkSizeBytes": "A String", # The chunk size of checksums. Must be a multiple of 256KB.
- "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # If set, calculate the checksums based on the contents and return them to the caller.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- "objectSizeBytes": "A String", # The total size of the server object.
- "objectVersion": "A String", # The object version of the object the checksums are being returned for.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
},
- "diffDownloadResponse": { # Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
- "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The original object location.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
+ },
+ },
+ "diffUploadRequest": { # A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_REQUEST.
+ "checksumsInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "diffUploadRequest": { # A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_REQUEST.
- "checksumsInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- "objectInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
- "objectVersion": "A String", # The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
},
- "diffUploadResponse": { # Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_RESPONSE.
- "objectVersion": "A String", # The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
- "originalObject": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
- "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
- "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
- "blobGeneration": "A String", # The blob generation id.
- "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
- "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
- "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
- "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
- },
- "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
- "crc32cHash": 42, # crc32.c hash for the payload.
- "inline": "A String", # Media data, set if reference_type is INLINE
- "length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # MD5 hash for the payload.
- "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
- "bucketName": "A String", # The name of the bucket to which this object belongs.
- "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
- "objectName": "A String", # The name of the object.
- },
- "path": "A String", # Path to the data, set if reference_type is PATH
- "referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # SHA-1 hash for the payload.
- },
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
+ },
+ "objectInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "diffVersionResponse": { # Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_VERSION_RESPONSE.
- "objectSizeBytes": "A String", # The total size of the server object.
- "objectVersion": "A String", # The version of the object stored at the server.
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # MD5 hash for the payload.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
},
- "downloadParameters": { # Parameters specific to media downloads. # Parameters for a media download.
- "allowGzipCompression": True or False, # A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
- "ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
+ },
+ "objectVersion": "A String", # The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
+ },
+ "diffUploadResponse": { # Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_RESPONSE.
+ "objectVersion": "A String", # The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
+ "originalObject": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
+ "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+ "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+ "blobGeneration": "A String", # The blob generation id.
+ "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+ "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+ "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+ "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
},
- "filename": "A String", # Original file name
- "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
- "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
+ "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+ "crc32cHash": 42, # crc32.c hash for the payload.
"inline": "A String", # Media data, set if reference_type is INLINE
- "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
"length": "A String", # Size of the data, in bytes
- "md5Hash": "A String", # Scotty-provided MD5 hash for an upload.
- "mediaId": "A String", # Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
+ "md5Hash": "A String", # MD5 hash for the payload.
"objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
"bucketName": "A String", # The name of the bucket to which this object belongs.
"generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
@@ -572,22 +299,56 @@ Method Details
},
"path": "A String", # Path to the data, set if reference_type is PATH
"referenceType": "A String", # Describes what the field reference contains.
- "sha1Hash": "A String", # Scotty-provided SHA1 hash for an upload.
- "sha256Hash": "A String", # Scotty-provided SHA256 hash for an upload.
- "timestamp": "A String", # Time at which the media data was last updated, in milliseconds since UNIX epoch
- "token": "A String", # A unique fingerprint/version id for the media data
+ "sha1Hash": "A String", # SHA-1 hash for the payload.
},
- "originalObjectBlobMintIndex": 42, # For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
- "requestClass": "A String", # Request class to use for all Blobstore operations for this request.
- "scottyAgentUserId": "A String", # Requester ID passed along to be recorded in the Scotty logs
- "scottyCustomerLog": "A String", # Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
- "trafficClassField": "A String", # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
- "verifyHashFromHeader": True or False, # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
},
- "sourceId": { # SourceId is the last segment of the source's resource name. # The source id of the uploaded source.
- "id": "A String", # The id of the source.
+ "diffVersionResponse": { # Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_VERSION_RESPONSE.
+ "objectSizeBytes": "A String", # The total size of the server object.
+ "objectVersion": "A String", # The version of the object stored at the server.
+ },
+ "downloadParameters": { # Parameters specific to media downloads. # Parameters for a media download.
+ "allowGzipCompression": True or False, # A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
+ "ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
},
+ "filename": "A String", # Original file name
+ "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
+ "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
+ "inline": "A String", # Media data, set if reference_type is INLINE
+ "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
+ "length": "A String", # Size of the data, in bytes
+ "md5Hash": "A String", # Scotty-provided MD5 hash for an upload.
+ "mediaId": "A String", # Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
+ "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+ "bucketName": "A String", # The name of the bucket to which this object belongs.
+ "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+ "objectName": "A String", # The name of the object.
+ },
+ "path": "A String", # Path to the data, set if reference_type is PATH
+ "referenceType": "A String", # Describes what the field reference contains.
+ "sha1Hash": "A String", # Scotty-provided SHA1 hash for an upload.
+ "sha256Hash": "A String", # Scotty-provided SHA256 hash for an upload.
+ "timestamp": "A String", # Time at which the media data was last updated, in milliseconds since UNIX epoch
+ "token": "A String", # A unique fingerprint/version id for the media data
}
+
+ download_media(name, fileId=None, viewId=None, x__xgafv=None)
+ Downloads a file from the session.
+
+Args:
+ name: string, Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` (required)
+ fileId: string, Required. The ID of the file to be downloaded.
+ viewId: string, Optional. The ID of the view to be downloaded.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ The media object as a string.
+
+
+
+